Recupera a lista de departamentos cadastrados pela empresa, com suporte à paginação e filtro por busca.
📌 Por que listar departamentos?
A listagem de departamentos auxilia na identificação dos departamentos que estão sendo utilizados de fato.
- Controle de atendentes em cada departamento.
- Organização da equipe.
🔗 Endpoint:
Método: GET
Endpoint: https://api.nuvidio.com/v1/api/departments
🔎 Parâmetros da URL:
Parâmetro | Padrão | Tipo | Obrigatório | Descrição |
---|---|---|---|---|
take | 10 | number | ❌ | Número de departamentos a serem retornados |
page | 1 | number | ❌ | Página atual da listagem |
search | - | string | ❌ | Filtro por nome ou identificador do departamento |
✅ Exemplo de Resposta:
{
"count": 8,
"departments": [
{
"id": "5f71281d112758f7d019c7c4",
"identifier": "nuvidio-department",
"name": "Department",
"type": 3,
"attendants": 1,
"disabled": false,
"queueLength": 0
}
]
}
count
: Total de departamentos encontradosdepartments
: Lista dos departamentos conforme os filtros aplicadosattendants
: Total de atendentes vinculadosidentifier
: Identificador do departamentoname
: Nome do departamento
❌ Respostas de Erro:
Código | Descrição |
---|---|
500 | Erro interno |