ReadMe_GetCompaniesResponse

Página de empresas da API v2

companies object[]

Empresas retornadas na página atual

Lista [

companyIdstring<uuid>

Identificador da empresa

Exemplo 64091b0a-529d-48fc-9802-7b1600a07c8b

companyTaxIdstring

CPF ou CNPJ da empresa

Exemplo 12345678000195

companyNamestring

Nome da empresa

Exemplo Empresa Teste v2

statusstring

Status da empresa

Valores possíveis: [ACTIVE, INACTIVE]

Exemplo ACTIVE

scheduleStatusstring

Status da agenda da empresa

Valores possíveis: [ACTIVE, INACTIVE, PERFORMED, PENDING, SENT]

Exemplo PENDING

createdAtstring<date-time>

Data de criação em UTC

Exemplo 2026-04-17T12:30:00Z

updatedAtstring<date-time>aceita valor nulo

Data de atualização em UTC

Exemplo 2026-04-17T13:45:00Z

links object[]

Links de navegação da API

Lista [

relstring

Relação do link com o recurso atual

Exemplo self

methodstring

Método HTTP do link

Exemplo GET

hrefstring

Caminho relativo do recurso

Exemplo /api/v2/companies

descriptionstring

Explicação em português do que este link permite fazer

Exemplo Cadastre a empresa para o cliente

]

]

pagination object

Metadados de paginação baseada em cursor

currentItemstring

ID do item atual (primeiro da página)

Exemplo fe2cc560-036c-44cd-90e8-294d5a74cebc

limitinteger<int32>

Número de itens por página

Exemplo 30

nextItemstringaceita valor nulo

ID do próximo item (cursor para a próxima página)

Exemplo 22222222-2222-4222-8222-222222222222

totalItemsinteger<int64>

Total de itens disponíveis

Exemplo 150

links object[]

Links de navegação da API

Lista [

relstring

Relação do link com o recurso atual

Exemplo self

methodstring

Método HTTP do link

Exemplo GET

hrefstring

Caminho relativo do recurso

Exemplo /api/v2/companies

descriptionstring

Explicação em português do que este link permite fazer

Exemplo Cadastre a empresa para o cliente

]

ReadMe_GetCompaniesResponse

{
  "companies": [
    {
      "companyId": "64091b0a-529d-48fc-9802-7b1600a07c8b",
      "companyTaxId": "12345678000195",
      "companyName": "Empresa Teste v2",
      "status": "ACTIVE",
      "scheduleStatus": "PENDING",
      "createdAt": "2026-04-17T12:30:00Z",
      "updatedAt": "2026-04-17T13:45:00Z",
      "links": [
        {
          "rel": "self",
          "method": "GET",
          "href": "/api/v2/companies",
          "description": "Cadastre a empresa para o cliente"
        }
      ]
    }
  ],
  "pagination": {
    "currentItem": "fe2cc560-036c-44cd-90e8-294d5a74cebc",
    "limit": 30,
    "nextItem": "22222222-2222-4222-8222-222222222222",
    "totalItems": 150
  },
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "/api/v2/companies",
      "description": "Cadastre a empresa para o cliente"
    }
  ]
}