get
https://api.operand.app/beta/entity/clients
Retorna Todos os Clientes
| Field | Type | Field Name corresponding | Description | Return Type |
|---|---|---|---|---|
| actualSituation | Enum | Situação | Retorna a situação do cadastro. | 'active' ou 'disabled' |
| address | String | Logradouro | Retorna o logradouro do cadastro. | string vazia ou string com dados |
| addressComplement | String | Complemento | Retorna o complemento de endereço do cadastro. | string vazia ou string com dados |
| addressNumber | String | Número do logradouro | Retorno o número do logradouro do cadastro. | string vazia ou string com dados |
| briefing | String | Resumo | Retorna o resumo do cadastro | string vazia ou string com dados |
| cep | String | CEP | Retorna o CEP. | string vazia ou string com dados |
| city | String | Cidade | Retorna a cidade. | string vazia ou string com dados |
| cityState | String | Cidade e UF | Retorna o nome da cidade e a UF | string vazia ou string com dados |
| company | Boolean | Validação PJ | Retorna se o cadastro é de do tipo PJ. | true ou false |
| contacts | Array of Objects | Informações de contato | Retorna as informações de contact, email, phone | Array de um ou mais Objetos |
| Estrutura de contacts | ||||
| contact | String | Nome do contato | Retorna o nome do contato. | string vazia ou string com dados |
| String | Retorna o e-mail do contato | string vazia ou string com dados | ||
| phone | String | Telefone 1 | Retorna o primeiro número do telefone do cadastro. | string vazia ou string com dados |
| district | String | Bairro | Retorna o bairro. | string vazia ou string com dados |
| String | Retorna o e-mail. | string vazia ou string com dados | ||
| firstContact | String | Nome do primeiro contato | Retorna o nome do primeiro contato. | string vazia ou string com dados |
| idClient | Integer | ID do cliente | Retorna o ID do cliente. | string vazia ou integer |
| lateJobs | Integer | Jobs em atraso | Retorna a quantidade de jobs em atraso para o cliente | string vazia ou integer |
| locality | Object | Informações do endereço | Retorna um Objeto (JSON) com as informações: cep, address, addressNumber, addressComplement, district, state, state, city, city, codIBGE, country | Object |
| Estrutura locality | ||||
| cep | String | CEP | Retorna o CEP. | string vazia ou string com dados |
| address | String | Logradouro | Retorna o logradouro do cadastro. | string vazia ou string com dados |
| addressNumber | String | Número do logradouro | Retorno o número do logradouro do cadastro. | string vazia ou string com dados |
| addressComplement | String | Complemento | Retorna o complemento de endereço do cadastro. | string vazia ou string com dados |
| district | String | Bairro | Retorna o bairro. | string vazia ou string com dados |
| state | String | UF | Retorna a Unidade Federativa (UF). | string vazia ou string com dados |
| state | String | UF | Retorna a Unidade Federativa (UF). | string vazia ou string com dados |
| city | String | Cidade (Estado) | Retorna a cidade e a Unidade Federativa (UF). | string vazia ou string com dados |
| codCity | Integer | Código da cidade | Retorna o código da cidade | string vazia ou integer |
| codIBGE | Integer | Código da cidade no IBGE | Retorno o código da cidade no cadastro do IBGE | string vazia ou integer |
| country | String | País | Retorna o país. | string vazia ou string com dados |
| nationalDocument | String | CPF ou CNPJ | Retorna o valor do campo CPF ou CNPJ | string vazia ou string com dados |
| person | String | Nome Fantasia | Retorna o nome fantasia do cadastro. | string vazia ou string com dados |
| phone | String | Telefone 1 | Retorna o número do telefone do cadastro. | string vazia ou string com dados |
| phone2 | String | Telefone 2 | Retorna o número do telefone do cadastro. | string vazia ou string com dados |
| state | String | UF | Retorna a Unidade Federativa (UF). | string vazia ou string com dados |
| totalJobs | Integer | Total de jobs do cliente | Retorna a quantidade de jobs cadastrados para o cliente. | string vazia ou integer |
| typeNationalDocument | String | Tipo de documento | Retorna se o documento é um CPF ou um CNPJ. | 'cpf' ou 'cnpj' |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…