/companies
Companies
Empresas agregam pessoas e deals. Use companies para B2B onde a entidade primária de venda é a organização, não o indivíduo. Pessoas podem ter `companyId` e deals podem ter `primaryCompanyId`.
- Domínio (`domain`) facilita auto-vincular pessoas pelo e-mail (futuro).
- Tamanho (`size`) é categórico (1-10, 11-50, ...), não numérico livre.
- DELETE remove a empresa; pessoas vinculadas permanecem.
- Webhooks: company.created, company.updated.
Endpoints
Clique em qualquer linha pra ir direto à reference detalhada.
Reference
GET
/companiesListar empresas
Apenas paginação na v1 atual; filtros adicionais virão em versões futuras.
Query parameters
pageinteger
Número da página (1-indexado).
pageSizeinteger
Itens por página. Máximo 100.
Responses
200OK.
Resposta 200
pageintegerrequired
Sem descrição
pageSizeintegerrequired
Sem descrição
totalintegerrequired
Sem descrição
hasMorebooleanrequired
Sem descrição
dataarray<Company>required
Sem descrição
curl https://api.usemix.app/api/v1/companies \
-H "Authorization: Bearer manu_seu_token_aqui"GET
/companies/{id}Buscar empresa
Path parameters
idstring<uuid>required
Identificador único do recurso.
Responses
200OK.
Resposta 200
idstring<uuid>required
Sem descrição
tenantIdstring<uuid>required
Sem descrição
namestringrequired
Sem descrição
domainstring
Sem descrição
industrystring
Sem descrição
sizeenum<"1-10" | "11-50" | "51-200" | …>
Sem descrição
1-1011-5051-200201-500501-10001000+lifecycleStageenum<"prospect" | "customer" | "former_customer">
Sem descrição
prospectcustomerformer_customerownerIdstring<uuid>
Sem descrição
tagsarray<string>
Sem descrição
customFieldsobject
Campos customizados do workspace, expostos como leitura.
createdAtstring<date-time>required
Sem descrição
updatedAtstring<date-time>required
Sem descrição
curl https://api.usemix.app/api/v1/companies/<id> \
-H "Authorization: Bearer manu_seu_token_aqui"POST
/companiesCriar empresa
Request body
namestringrequired
Sem descrição
domainstring
Sem descrição
industrystring
Sem descrição
sizeenum<"1-10" | "11-50" | "51-200" | …>
Sem descrição
1-1011-5051-200201-500501-10001000+lifecycleStageenum<"prospect" | "customer" | "former_customer">
Sem descrição
prospectcustomerformer_customerownerIdstring<uuid>
Sem descrição
Responses
201Criada.
Resposta 201
idstring<uuid>required
Sem descrição
tenantIdstring<uuid>required
Sem descrição
namestringrequired
Sem descrição
domainstring
Sem descrição
industrystring
Sem descrição
sizeenum<"1-10" | "11-50" | "51-200" | …>
Sem descrição
1-1011-5051-200201-500501-10001000+lifecycleStageenum<"prospect" | "customer" | "former_customer">
Sem descrição
prospectcustomerformer_customerownerIdstring<uuid>
Sem descrição
tagsarray<string>
Sem descrição
customFieldsobject
Campos customizados do workspace, expostos como leitura.
createdAtstring<date-time>required
Sem descrição
updatedAtstring<date-time>required
Sem descrição
curl -X POST https://api.usemix.app/api/v1/companies \
-H "Authorization: Bearer manu_seu_token_aqui" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"domain": "string",
"industry": "string",
"size": "1-10",
"lifecycleStage": "prospect",
"ownerId": "00000000-0000-0000-0000-000000000000"
}'PATCH
/companies/{id}Atualizar empresa
Path parameters
idstring<uuid>required
Identificador único do recurso.
Request body
namestring
Sem descrição
domainstring
Sem descrição
industrystring
Sem descrição
sizeenum<"1-10" | "11-50" | "51-200" | …>
Sem descrição
1-1011-5051-200201-500501-10001000+lifecycleStageenum<"prospect" | "customer" | "former_customer">
Sem descrição
prospectcustomerformer_customerownerIdstring<uuid>
Sem descrição
Responses
200OK.
Resposta 200
idstring<uuid>required
Sem descrição
tenantIdstring<uuid>required
Sem descrição
namestringrequired
Sem descrição
domainstring
Sem descrição
industrystring
Sem descrição
sizeenum<"1-10" | "11-50" | "51-200" | …>
Sem descrição
1-1011-5051-200201-500501-10001000+lifecycleStageenum<"prospect" | "customer" | "former_customer">
Sem descrição
prospectcustomerformer_customerownerIdstring<uuid>
Sem descrição
tagsarray<string>
Sem descrição
customFieldsobject
Campos customizados do workspace, expostos como leitura.
createdAtstring<date-time>required
Sem descrição
updatedAtstring<date-time>required
Sem descrição
curl -X PATCH https://api.usemix.app/api/v1/companies/<id> \
-H "Authorization: Bearer manu_seu_token_aqui" \
-H "Content-Type: application/json" \
-d '{
"name": "string",
"domain": "string",
"industry": "string",
"size": "1-10",
"lifecycleStage": "prospect",
"ownerId": "00000000-0000-0000-0000-000000000000"
}'DELETE
/companies/{id}Apagar empresa
Path parameters
idstring<uuid>required
Identificador único do recurso.
Responses
204Apagada.
curl -X DELETE https://api.usemix.app/api/v1/companies/<id> \
-H "Authorization: Bearer manu_seu_token_aqui"