# Lista de empresas

Retorna lista de empresas.

Endpoint: GET /api/v3/companies
Version: 3.0.0
Security: OAuth2

## Query parameters:

  - `companies_id` (string)
    Filtro pelos IDs das empresas. Pode passar mais de um ID numérico separado por virgula.
    Example: "1,2,3"

  - `name` (string)
    Filtro pelo nome fantasia da empresa.
    Example: "Connectplug"

  - `company_name` (string)
    Filtro pela razão social da empresa.
    Example: "ConnectPlug Desenvolvimento de Software LTDA"

  - `cnpj` (string)
    Filtro pelo CNPJ da empresa.
    Example: "13.807.874/0001-05"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

## Response 200 fields (application/json):

  - `data` (object)

  - `data.companies` (array)
    Representa a lista de empresas

  - `data.companies.id` (integer)
    Identificador único da empresa.
    Example: 123

  - `data.companies.name` (string)
    Nome fantasia da empresa.
    Example: "ConnectPlug"

  - `data.companies.code` (string)
    Código da empresa.
    Example: "100"

  - `data.companies.image_url` (string)
    URL do logo da empresa.
    Example: "https://cdn.site.com.br/content/logo.png"

  - `data.companies.type_of_business` (object)

  - `data.companies.type_of_business.id` (integer)
    ID único do tipo de negócio
    Example: 99

  - `data.companies.type_of_business.type` (string)
    Nome identificador do tipo de negócio
    Example: "handcraft_shop"

  - `data.companies.type_of_business.description` (string)
    Descrição do tipo de negócio
    Example: "Artesanato"

  - `data.companies.type_of_business.created_at` (string)
    Data e hora de criação do tipo de negócio
    Example: "2025-07-14T13:31:26.000000Z"

  - `data.companies.type_of_business.updated_at` (string)
    Data e hora da última atualização do tipo de negócio
    Example: "2025-07-14T13:31:26.000000Z"

  - `data.companies.company_name` (string)
    Razão social da empresa
    Example: "ConnectPlug Desenvolvimento de Software LTDA"

  - `data.companies.founding_date` (string)
    Data da fundação da empresa. Formato "YYYY-MM-DD"
    Example: "2016-01-15"

  - `data.companies.cnae` (object)
    Representa uma CNAE.

  - `data.companies.cnae.id` (integer)
    Identificador único da CNAE.
    Example: 3

  - `data.companies.cnae.code` (integer)
    Código da CNAE.
    Example: 111303

  - `data.companies.cnae.name` (string)
    Nome da CNAE.
    Example: "Cultivo de trigo"

  - `data.companies.documents` (array)
    Lista de documentos da empresa.

  - `data.companies.documents.type` (string, required)
    Indica o tipo do documento.

- cpf: CPF Pessoa física
- rg: RG Pessoa física
- cnpj: CNPJ Pessoa jurídica
- ie: Inscrição Estadual Pessoa jurídica
- im: Inscrição Municipal Pessoa jurídica
    Enum: "cpf", "rg", "cnpj", "ie", "im"

  - `data.companies.documents.identify` (string, required)
    Identificação do documento.
    Example: "11144477735"

  - `data.companies.address` (object)
    Dados do endereço

  - `data.companies.address.id` (number)
    id do endereço.
    Example: 220

  - `data.companies.address.nickname` (string)
    Apelido do endereço.
    Example: "Casa"

  - `data.companies.address.type` (string, required)
    Tipo do endereço.

- default endereço principal.
- shipping endereço de entrega.
- charge endereço de cobrança.
- other outro tipo de endereço.
    Enum: "default", "shipping", "charge", "other"

  - `data.companies.address.street` (string, required)
    Nome do logradouro (Rua, Avenida, praça, etc).
    Example: "Avenida Paulista"

  - `data.companies.address.number` (string)
    Número do logradouro.
    Example: "42 A"

  - `data.companies.address.city_id` (number)
    ID da cidade.

Obrigatório quando o campo ibge_code não for passado.
    Example: 1234

  - `data.companies.address.ibge_code` (string)
    Código do município segundo IBGE.

Exemplo: O código do município segundo IBGE é 3550308

Obrigatório quando o campo city_id não for passado.
    Example: "3550308"

  - `data.companies.address.state` (string)
    Sigla do estado do endereço.
    Example: "SP"

  - `data.companies.address.city` (string)
    Nome da cidade.
    Example: "São Paulo"

  - `data.companies.address.neighborhood` (string)
    Nome do Bairro.
    Example: "Bela Vista"

  - `data.companies.address.complement` (string)
    Complemento do endereço.
    Example: "Apto 2550"

  - `data.companies.address.zip_code` (string)
    CEP do endereço.
    Example: "01311000"

  - `data.companies.contacts` (array)
    Lista de contatos da empresa.

  - `data.companies.contacts.type` (string, required)
    Indica o tipo do contato.

- mobile: Número de telefone celular
- phone: Número de telefone (fixo ou celular)
- email: E-mail de contato
    Enum: "mobile", "phone", "email"

  - `data.companies.contacts.value` (string, required)
    Dados do contato.
    Example: "joe@example.com"

  - `data.companies.contacts.id` (number)
    Id do contato na CPlug.
    Example: 271

  - `data.companies.owner_contact` (object)
    Contato do proprietário da empresa.

  - `data.companies.owner_contact.name` (string)
    Nome do contato do proprietário da empresa.
    Example: "João da Silva"

  - `data.companies.owner_contact.contacts` (array)
    Lista de contatos do proprietário da empresa.

  - `data.companies.financial_contact` (object)
    Contato financeiro da empresa.

  - `data.companies.financial_contact.name` (string)
    Nome do contato financeiro da empresa.
    Example: "João da Silva"

  - `data.companies.financial_contact.contacts` (array)
    Lista de contatos do contato financeiro da empresa.

  - `data.companies.settings` (object)
    Configurações da Empresa.

  - `data.companies.settings.theme` (object)
    Configurações do Tema.

  - `data.companies.settings.theme.primary_color` (string)
    Cor primárias (HEXA)
    Example: "#123123"

  - `data.companies.settings.theme.secondary_color` (string)
    Cor secundária (HEXA)
    Example: "#123123"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields