Skip to main content
GET
/
api
/
v1
/
categories
/
{id}
Retrieve a category
curl --request GET \
  --url https://app.sure.am/api/v1/categories/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "color": "<string>",
  "icon": "<string>",
  "subcategories_count": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "parent": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  }
}

Authorizations

​
X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Path Parameters

​
id
string
required

Category ID

Response

subcategory retrieved with parent

​
id
string<uuid>
required
​
name
string
required
​
classification
enum<string>
required
Available options:
income,
expense
​
color
string
required
​
icon
string
required
​
subcategories_count
integer
required
Required range: x >= 0
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
parent
object | null