A Empresa é uma das três Entidades do RD Station CRM:
- Empresa
- Negociação
- Contato
Empresa é a entidade jurídica que pode ser vinculada a uma Negociação.
Atenção
Toda informação cadastrada deve conter no mínimo 2 caracteres.
Query params
Parâmetros utilizados para listar e exibir Empresas.
| Nome | Tipo | Descrição |
|---|---|---|
| token | String | Token do usuário |
| organization_id | URL | ID da Empresa a ser exibida |
| page | String | Página da listagem de empresas. Valor padrão é 1 |
| limit | URL | Limite de empresas que virão por listagem. Valor padrão é 20. Valor máximo é 200 |
| order | URL | Campo a ser ordenado. Valor padrão é "name" |
| direction | URL | Ordenação da lista. "asc" ou "desc", padrão é "asc" |
| organization_segment | URL | ID do segmento. Busca todas as empresas que têm esse segmento |
| user_id | URL | ID do usuário. Busca as empresas do usuário anterior no parâmetro |
| q | String | String com o nome da empresa. Busca as empresas com a string anterior no parâmetro |
Body params
Parâmetros utilizados para criar e atualizar Empresas.
| Nome | Tipo | Descrição | Obrigatório | Observação |
|---|---|---|---|---|
| name | String | Nome da empresa | ✓ | Mínimo 2 caracteres, não pode se repetir. Obrigatório somente ao criar a empresa |
| organization_custom_fields | Array of objects | Campos personalizados da empresa | ✘ | Obrigatório, se o campo estiver marcado como obrigatório nas configurações do sistema |
| resume | String | Resumo da empresa | ✘ | |
| url | String | URL da empresa | ✘ | |
| organization_segments | Array of strings | Segmentos da empresa | ✘ | Área de atuação da empresa. Caso exista no sistema, associa-o à empresa. Caso contrário, cria um novo segmento e associa-o à empresa |
| user_id | String | ID do Usuário responsável pela empresa | ✘ |
Response Body params
Parâmetros retornados ao listar e exibir Empresas.
| Campo | Tipo | Descrição |
|---|---|---|
| has more | Boolean | |
| organizations | Array of objects | Listagem de empresas |
| organizations_id | String | ID da empresa |
| organizations_name | String | Nome da Empresa |
| address | String | Endereço da empresa |
| String | Facebook da empresa | |
| String | Linkedin da empresa | |
| notes | String | Anotações |
| String | Email dos usuários da Equipe | |
| team_users | Array of objects | Usuários da Equipe |
| team_users_id | String | ID dos usuários da Equipe |
| team_users_name | String | Nome dos usuários da Equipe |
| team_users_name | String | Email dos usuários da Equipe |
| name | String | Nome da Equipe |
| phone | String | Telefone do usuário |
| teams | Array | Equipes na qual o usuário faz parte. |