v1

latestOpenAPI 3.1.02026-08-041420513.7 KB

Listar departamentos

Permite obter uma lista paginada de até 100 departamentos vinculados a um escritório contábil, com suporte a OData.

get/v1/accountingfirms/{accountingFirmId}/departments

Path parameters

accountingFirmIdstring required

Id do escritório.

Query parameters

$filterstring

Filtra os resultados com base em critérios específicos. Exemplo: filter=Name eq 'Usuário X'.

$skipstring

Define o número de resultados a serem ignorados. Exemplo: skip=10.

$topstring

Limita o número de resultados retornados. Exemplo: top=5.

$orderbystring

Ordena os resultados. Exemplo: orderby=Name asc.

Headers

X-API-Keystring

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

X-User-Idstring

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Response

200

Example response

{
  "items": [
    {
      "id": "id",
      "inChargeUserId": "id",
      "name": "string",
      "CreatedAt": "2025-05-13T14:24:36.655Z",
      "CreatedBy": "string",
      "UpdatedAt": "2025-05-13T14:24:36.655Z",
      "UpdatedBy": "string"
    }
  ],
  "metadata": {
    "totalAllItems": "int",
    "total": "int"
  }
}