PluggyDocs
GET/categories

Lista

Recupera todas as categorias ativas da categorização de dados. Pode ser filtrado pelo parentId da categoria.

Parameters

Query Parameters

NameType
parentId
string

Responses

200Recupere uma lista de todas as categorias
object

Paginated list of transaction categories

resultsrequiredobject[]

Categorias para a página atual

itemsobject

Cateogry response

pagerequirednumber (double)
totalrequirednumber (double)
totalPagesrequirednumber (double)

Example response

json
{
  "page": 1,
  "total": 2,
  "totalPages": 1,
  "results": [
    {
      "id": "01000000",
      "description": "Income",
      "descriptionTranslated": "Renda"
    },
    {
      "id": "01010000",
      "description": "Salary/pro-labore",
      "descriptionTranslated": "Salário",
      "parentId": "01000000",
      "parentDescription": "Income"
    }
  ]
}
curl -X GET \
  'https://api.pluggy.ai/categories' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY'
Resposta de exemplo
{
  "page": 1,
  "total": 2,
  "totalPages": 1,
  "results": [
    {
      "id": "01000000",
      "description": "Income",
      "descriptionTranslated": "Renda"
    },
    {
      "id": "01010000",
      "description": "Salary/pro-labore",
      "descriptionTranslated": "Salário",
      "parentId": "01000000",
      "parentDescription": "Income"
    }
  ]
}