Sectores
Los sectores agrupan departamentos lógicamente (ej: "Comercial", "Soporte"). Requiere rol de supervisor o superior.
Endpoints
| Método | Endpoint | Descripción | Rol Mínimo |
|---|---|---|---|
GET | /api/v1/sectors | Listar sectores | supervisor |
POST | /api/v1/sectors | Crear sector | supervisor |
GET | /api/v1/sectors/:id | Buscar sector | supervisor |
PUT | /api/v1/sectors/:id | Actualizar sector | supervisor |
DELETE | /api/v1/sectors/:id | Eliminar sector | supervisor |
Listar Sectores
GET /api/v1/sectorsQuery Parameters
| Parámetro | Tipo | Predeterminado | Descripción |
|---|---|---|---|
page | integer | 1 | Número de página |
page_size | integer | 20 | Elementos por página |
sort_by | string | name | Campo para ordenamiento |
sort_order | string | asc | Dirección del ordenamiento |
Ejemplo de Request
bash
curl -X GET "https://voki.avanter.com.br/api/v1/sectors" \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Respuesta Exitosa (200)
json
{
"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
}
}Crear Sector
POST /api/v1/sectorsRequest Body
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
name | string | Sí | Nombre del sector |
description | string | No | Descripción |
Ejemplo de Request
bash
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"
}
}'Respuesta Exitosa (201)
json
{
"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 Sector
GET /api/v1/sectors/:idEjemplo de Request
bash
curl -X GET https://voki.avanter.com.br/api/v1/sectors/f6a7b8c9-d0e1-2345-fghi-678901234567 \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Actualizar Sector
PUT /api/v1/sectors/:idEjemplo de Request
bash
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"
}
}'Respuesta Exitosa (200)
json
{
"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"
}
}Eliminar Sector
DELETE /api/v1/sectors/:idNota
Los sectores con departamentos asociados no pueden eliminarse. Elimine los departamentos primero.
Ejemplo de Request
bash
curl -X DELETE https://voki.avanter.com.br/api/v1/sectors/b8c9d0e1-f2a3-4567-hijk-890123456789 \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Respuesta Exitosa (204)
Sin cuerpo en la respuesta.
