Category

Get a category by ID

Retrieves a single category by its unique identifier.

get/v1/category/{id}

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/category/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Category ID

Response

The category has been successfully retrieved.

idstring

Unique identifier for the Category.

createdAtstring date-time

Timestamp when the Category was created.

updatedAtstring date-time

Timestamp when the Category was last updated.

companyIdstring

Company ID associated with the Category.

externalIdstring

External ID of the category.

namestring

Name of the category.

descriptionstring

Description of the category.

imagestring

Image of the category.

parentIdstring

Parent ID of the category.

menuOrdernumber

Menu order of the category.

sourcestring

Source of the category.

Example response

{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "externalId": "1234567890",
  "name": "Beverages",
  "description": "Beverages are drinks that are not alcoholic.",
  "image": "https://example.com/image.jpg",
  "parentId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "menuOrder": 1,
  "source": "manual"
}

Changes

No recorded changes to this operation across all 1 revision of this API.