Listar Departamentos

Lista departamentos da matriz e filiais com paginação. Requer scope departamentos:read.

Autenticação:

🔑 API Key

Parâmetros de Consulta

searchstring

Buscar por nome do departamento

pagenumber

Página (padrão: 1)

limitnumber

Itens por página (padrão: 100, máximo: 500)

Respostas

{
  "ok": true,
  "data": {
    "departamentos": [
      {
        "departamento_id": 5,
        "empresa_id": 1,
        "nome_departamento": "Tecnologia",
        "local": "Escritório Central",
        "created_at": "2026-01-01T10:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 100,
      "total": 10,
      "totalPages": 1
    }
  }
}

Sandbox Mode

curl --request GET \
  'http://localhost:3000/api/v1/departamentos?search=TI&page=1&limit=100' \
  --header 'x-api-key: yk_sua_api_key'

Exemplos de Resposta

{
  "ok": true,
  "data": {
    "departamentos": [
      {
        "departamento_id": 5,
        "empresa_id": 1,
        "nome_departamento": "Tecnologia",
        "local": "Escritório Central",
        "created_at": "2026-01-01T10:00:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 100,
      "total": 10,
      "totalPages": 1
    }
  }
}