Categories API · Pasona Finance Tracker API

GET /api/categories

List categories

Returns the authenticated user's categories, including the seeded defaults.

Response

[
  {
    "id": 1,
    "user_id": 1,
    "name": "Salary",
    "type": "income"
  },
  {
    "id": 2,
    "user_id": 1,
    "name": "Groceries",
    "type": "expense"
  },
  {
    "id": 17,
    "user_id": 1,
    "name": "Side Hustle",
    "type": "income"
  }
]

{ "message": "Unauthenticated." }

POST /api/categories

Create a category

Creates a custom category owned by the authenticated user.

Request body

Name	Type	Required	Description
`name`	string	Required	Category name. Max `255` characters.
`type`	string	Required	One of: `income`, `expense`.

Request body example

{
  "name": "Side Hustle",
  "type": "income"
}

Responses

{
  "id": 17,
  "user_id": 1,
  "name": "Side Hustle",
  "type": "income"
}

{
  "message": "The given data was invalid.",
  "errors": {
    "type": ["The selected type is invalid."]
  }
}

GET /api/categories/{id}

Retrieve a category

Returns a single category by ID.

Path parameters

Name	Type	Required	Description
`id`	integer	Required	The category's unique identifier.

PUT /api/categories/{id}

Update a category

Updates a category owned by the authenticated user. Duplicate (name, type) pairs are blocked by a unique key and return 422.

Request body

Name	Type	Required	Description
`name`	string	Optional	New category name.
`type`	string	Optional	One of: `income`, `expense`.

Responses

{
  "id": 17,
  "user_id": 1,
  "name": "Freelance Work",
  "type": "income"
}

{
  "message": "The given data was invalid.",
  "errors": {
    "name": ["The name has already been taken."]
  }
}

DELETE /api/categories/{id}

Delete a category

Deletes a category owned by the authenticated user, including the seeded defaults.

Response

HTTP/1.1 204 No Content