Explorar a referência

Grupos de categorias

4 endpoints · As descrições dos endpoints estão em inglês.

List category groups in this household

GET/households/{householdId}/category-groups

read:categories

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X GET https://api.vokse.ai/households/current/category-groups

Resposta200 · Success

Create a category group

POST/households/{householdId}/category-groups

write:categories

Corpo do pedido

json

{  "name": "Essentials"}

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Content-Type: application/json" \     -H "Idempotency-Key: $(uuidgen)" \     -X POST https://api.vokse.ai/households/current/category-groups \     -d '{"name":"Essentials"}'

Resposta201 · Success

Update a category group

PATCH/households/{householdId}/category-groups/{groupId}

write:categories

Parâmetros

Nome	Local	Obrigatório
groupId	path	Obrigatório

Corpo do pedido

json

{  "name": "Fixed costs"}

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -H "Content-Type: application/json" \     -H "Idempotency-Key: $(uuidgen)" \     -X PATCH https://api.vokse.ai/households/current/category-groups/{groupId} \     -d '{"name":"Fixed costs"}'

Resposta200 · Success

Soft-delete a category group

DELETE/households/{householdId}/category-groups/{groupId}

write:categories

Parâmetros

Nome	Local	Obrigatório
groupId	path	Obrigatório

Exemplo de pedido

bash

curl -H "Authorization: Bearer vokse_sk_…" \     -X DELETE https://api.vokse.ai/households/current/category-groups/{groupId}

Resposta204 · No content