Setores

Setores agrupam departamentos logicamente (ex: "Comercial", "Suporte"). Requer papel de supervisor ou superior.

Endpoints

Método	Endpoint	Descrição	Role Mínimo
GET	/api/v1/sectors	Listar setores	supervisor
POST	/api/v1/sectors	Criar setor	supervisor
GET	/api/v1/sectors/:id	Buscar setor	supervisor
PUT	/api/v1/sectors/:id	Atualizar setor	supervisor
DELETE	/api/v1/sectors/:id	Excluir setor	supervisor

---

Listar Setores

GET /api/v1/sectors

Query Parameters

Parâmetro	Tipo	Padrão	Descrição
page	integer	1	Número da página
page_size	integer	20	Itens por página
sort_by	string	name	Campo para ordenação
sort_order	string	asc	Direção da ordenação

Exemplo de Request

curl -X GET "https://voki.avanter.com.br/api/v1/sectors" \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "X-Tenant: avanter"

Resposta de Sucesso (200)

{
  "data": [
    {
      "id": "f6a7b8c9-d0e1-2345-fghi-678901234567",
      "name": "Comercial",
      "description": "Setor comercial e vendas",
      "active": true,
      "department_count": 3,
      "inserted_at": "2026-01-05T08:00:00Z",
      "updated_at": "2026-01-05T08:00:00Z"
    },
    {
      "id": "a7b8c9d0-e1f2-3456-ghij-789012345678",
      "name": "Suporte",
      "description": "Setor de suporte técnico",
      "active": true,
      "department_count": 2,
      "inserted_at": "2026-01-05T08:30:00Z",
      "updated_at": "2026-01-05T08:30:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "page_size": 20,
    "total_pages": 1,
    "total_count": 2
  }
}

---

Criar Setor

POST /api/v1/sectors

Request Body

Campo	Tipo	Obrigatório	Descrição
name	string	Sim	Nome do setor
description	string	Não	Descrição

Exemplo de Request

curl -X POST https://voki.avanter.com.br/api/v1/sectors \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "X-Tenant: avanter" \
  -H "Content-Type: application/json" \
  -d '{
    "sector": {
      "name": "Financeiro",
      "description": "Setor financeiro e cobrança"
    }
  }'

Resposta de Sucesso (201)

{
  "data": {
    "id": "b8c9d0e1-f2a3-4567-hijk-890123456789",
    "name": "Financeiro",
    "description": "Setor financeiro e cobrança",
    "active": true,
    "department_count": 0,
    "inserted_at": "2026-02-18T12:00:00Z",
    "updated_at": "2026-02-18T12:00:00Z"
  }
}

---

Buscar Setor

GET /api/v1/sectors/:id

Exemplo de Request

curl -X GET https://voki.avanter.com.br/api/v1/sectors/f6a7b8c9-d0e1-2345-fghi-678901234567 \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "X-Tenant: avanter"

---

Atualizar Setor

PUT /api/v1/sectors/:id

Exemplo de Request

curl -X PUT https://voki.avanter.com.br/api/v1/sectors/f6a7b8c9-d0e1-2345-fghi-678901234567 \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "X-Tenant: avanter" \
  -H "Content-Type: application/json" \
  -d '{
    "sector": {
      "name": "Comercial & Marketing"
    }
  }'

Resposta de Sucesso (200)

{
  "data": {
    "id": "f6a7b8c9-d0e1-2345-fghi-678901234567",
    "name": "Comercial & Marketing",
    "description": "Setor comercial e vendas",
    "active": true,
    "department_count": 3,
    "inserted_at": "2026-01-05T08:00:00Z",
    "updated_at": "2026-02-18T13:00:00Z"
  }
}

---

Excluir Setor

DELETE /api/v1/sectors/:id

Nota

Setores com departamentos associados não podem ser excluídos. Remova os departamentos primeiro.

Exemplo de Request

curl -X DELETE https://voki.avanter.com.br/api/v1/sectors/b8c9d0e1-f2a3-4567-hijk-890123456789 \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "X-Tenant: avanter"

Resposta de Sucesso (204)

Sem corpo na resposta.