Obter Departamentos

Obter Departamentos

Visão Geral

O endpoint /departments permite recuperar uma lista de departamentos associados a uma empresa específica.

Endpoint

GET /department

Requisição na API

curl -X GET https://api.pg.iappbr.com.br/api/v1/department \
     -H 'Authorization: Bearer SEU_TOKEN_AQUI' \
     -H 'Content-Type: application/json'

Resposta

A resposta inclui uma lista de departamentos.

Estrutura da Resposta

{
  "status": "success",
  "data": {
    "departments": [
      {
        "id": "string",
        "name": "string",
        "created_at": "2023-06-28T12:00:00Z",
        "attendants": [
          {
            "id": "string",
            "name": "string",
            "created_at": "2023-06-28T12:00:00Z",
            "is_supervisor": true
          }
        ]
      }
    ]
  }
}

Campos da Resposta

• status: Status da resposta (por exemplo, success).

• data: Objeto contendo os dados retornados.

  • departments: Array de departamentos.

    • id: ID do departamento.

    • name: Nome do departamento.

    • created_at: Data de criação do departamento.

    • attendants: Array de atendentes associados ao departamento.

      • id: ID do atendente.

      • name: Nome do atendente.

      • created_at: Data de criação do atendente.

      • is_supervisor: Supervisor do departamento