Listar Departamentos

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âmetroPadrãoTipoObrigatórioDescrição
take10numberNúmero de departamentos a serem retornados
page1numberPágina atual da listagem
search-stringFiltro 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 encontrados
  • departments: Lista dos departamentos conforme os filtros aplicados
  • attendants: Total de atendentes vinculados
  • identifier: Identificador do departamento
  • name: Nome do departamento

❌ Respostas de Erro:


CódigoDescrição
500Erro interno