Categories

Bulk read categories

Retrieves a list of categories. Supports filtering by fields, sorting, and pagination.

get/v1/categories

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/categories
  • Auth: API key in header x-api-key

Query parameters

skipnumber

Number of records to skip (default: 0)

limitnumber

Maximum number of records to return (default: 100, max: 1000)

sortBy'createdAt' | 'updatedAt' | 'name' | 'description'

Field name to sort results by

sortOrder'asc' | 'desc'

Sort direction (default: asc)

searchByNamestring

Field name to search by (case-insensitive partial match)

searchByDescriptionstring

Field name to search by (case-insensitive partial match)

searchBySourcestring

Field name to search by (case-insensitive partial match)

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by createdAt using range operators

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time

Filter by updatedAt using range operators

parentIdstring

Filter by parentId

Response

Successfully retrieved list of items

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "count": 1450,
    "limit": 100
  }
}

Changes

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