Sign in
v1Organizations

Retrieve an organization

Retorna uma organização pelo ID. Organizações excluídas também são retornadas, com deletedAt preenchido.

get/v1/organizations/{id}

Path parameters

idnumber required

ID da organização

Response

namestring required

Nome da organização / nome fantasia

legalNamestring nullable

Razão social

avatarstring nullable

Logo da organização (arquivo enviado pelo upload do Kinbox)

cnpjstring nullable

CNPJ (salvo sem pontuação)

websitestring nullable

Site da organização

domainstring nullable

Domínio normalizado, derivado automaticamente do site

phonestring nullable

Telefone da organização

emailstring nullable

E-mail da organização

segmentstring nullable

Segmento / setor de atuação

descriptionstring nullable

Descrição / observações

customFieldsobject nullable

Campos personalizados no formato { placeholder: { value } }

createdAtstring date-time required
updatedAtstring date-time required
deletedAtstring date-time nullable

Preenchido quando a organização foi excluída (exclusão lógica)

contactsCountnumber

Quantidade de contatos vinculados

idnumber required

ID da organização

workspaceIdnumber required

ID do workspace

operatorIdnumber nullable

ID do usuário responsável pela organização

Example response

{
  "id": 42
}

Changes

Changed in 1 of the 18 revisions of this API.1