Secteurs
Les secteurs regroupent les départements de manière logique (ex : "Commercial", "Support"). Nécessite le rôle supervisor ou supérieur.
Endpoints
| Méthode | Endpoint | Description | Rôle Minimum |
|---|---|---|---|
GET | /api/v1/sectors | Lister les secteurs | supervisor |
POST | /api/v1/sectors | Créer un secteur | supervisor |
GET | /api/v1/sectors/:id | Rechercher un secteur | supervisor |
PUT | /api/v1/sectors/:id | Mettre à jour un secteur | supervisor |
DELETE | /api/v1/sectors/:id | Supprimer un secteur | supervisor |
Lister les Secteurs
GET /api/v1/sectorsQuery Parameters
| Paramètre | Type | Défaut | Description |
|---|---|---|---|
page | integer | 1 | Numéro de page |
page_size | integer | 20 | Éléments par page |
sort_by | string | name | Champ de tri |
sort_order | string | asc | Direction du tri |
Exemple de Requête
bash
curl -X GET "https://voki.avanter.com.br/api/v1/sectors" \
-H "Authorization: Bearer eyJhbGci..." \
-H "X-Tenant: avanter"Réponse de Succès (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
}
}Créer un Secteur
POST /api/v1/sectorsRequest Body
| Champ | Type | Obligatoire | Description |
|---|---|---|---|
name | string | Oui | Nom du secteur |
description | string | Non | Description |
Exemple de Requête
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"
}
}'Réponse de Succès (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"
}
}Rechercher un Secteur
GET /api/v1/sectors/:idExemple de Requête
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"Mettre à Jour un Secteur
PUT /api/v1/sectors/:idExemple de Requête
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"
}
}'Réponse de Succès (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"
}
}Supprimer un Secteur
DELETE /api/v1/sectors/:idNote
Les secteurs avec des départements associés ne peuvent pas être supprimés. Retirez d'abord les départements.
Exemple de Requête
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"Réponse de Succès (204)
Pas de corps dans la réponse.
