ReferênciaCompanies
Companies
Nome obrigatório. Upsert por domain.
name é obrigatório no create e não pode ir vazio no PATCH. domain exemplo: analytical.example. Lookup por domain (miss é data: []). q busca name/domain.
| HTTP | Path | Scope |
|---|---|---|
| GET | /api/v1/companies | rest.crm.companies.read |
| POST | /api/v1/companies | rest.crm.companies.write |
| POST | /api/v1/companies/upsert | rest.crm.companies.write |
| GET | /api/v1/companies/{id} | rest.crm.companies.read |
| PATCH | /api/v1/companies/{id} | rest.crm.companies.write |
Query
| Parâmetro | Tipo | Notas |
|---|---|---|
| domain | string | Lookup. Miss é data: []. |
| q | string | Busca name e domain. |
| limit / cursor | number / string | Página de cursor. limit 1–100. |
Campos
| Campo | Tipo | Notas |
|---|---|---|
| id | UUID | Imutável. |
| name | string | Obrigatório no create. Não pode PATCH vazio. |
| domain | string | null | Ex.: analytical.example. "" vira null. |
| owner_id | UUID | null | Mesmo id de GET /members. |
| tag_ids | UUID[] | Replace total. [] limpa. |
| created_at / updated_at | datetime | ISO-8601 UTC. |