---
title: "Bulk read categories"
method: GET
path: "/v1/categories"
tags: ["Categories"]
---

# Bulk read categories

`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`

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

## Query parameters

- `skip` number
- `limit` number
- `sortBy` 'createdAt' | 'updatedAt' | 'name' | 'description'
- `sortOrder` 'asc' | 'desc'
- `searchByName` string
- `searchByDescription` string
- `searchBySource` string
- `createdAt` object
  - `gte` string, date-time
  - `lte` string, date-time
  - `gt` string, date-time
  - `lt` string, date-time
- `updatedAt` object
  - `gte` string, date-time
  - `lte` string, date-time
  - `gt` string, date-time
  - `lt` string, date-time
- `parentId` string

## Response `200`

Successfully retrieved list of items

- object
  - `data` CategoryResponseDto[]
    - `id` string: Unique identifier for the Category.
    - `createdAt` string, date-time: Timestamp when the Category was created.
    - `updatedAt` string, date-time: Timestamp when the Category was last updated.
    - `companyId` string: Company ID associated with the Category.
    - `externalId` string: External ID of the category.
    - `name` string: Name of the category.
    - `description` string: Description of the category.
    - `image` string: Image of the category.
    - `parentId` string: Parent ID of the category.
    - `menuOrder` number: Menu order of the category.
    - `source` string: Source of the category.
  - `meta` object
    - `count` number: Total number of items matching the query filters
    - `skip` number: Number of items skipped
    - `limit` number: Maximum number of items returned

## Other responses

- `400`: Bad request. Returns validation errors or other request-related errors.
- `404`: The resource(s) were not found.

---

[API](https://skmtc.dev/finalpos/apis/final-pos-public-api.md) · [All operations](https://skmtc.dev/finalpos/apis/final-pos-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/finalpos/apis/final-pos-public-api/revisions/6a6842dcb479?raw)