---
title: "Get a list of custom items for a specific property."
method: GET
path: "/item/v1/custom-items"
tags: ["Items"]
---

# Get a list of custom items for a specific property.

`GET /item/v1/custom-items`

## Request

- Base URL: `https://api.cloudbeds.com`
- URL: `https://api.cloudbeds.com/item/v1/custom-items`
- Auth: OAuth 2
  - Authorization code: `https://api.cloudbeds.com/auth/oauth/authorize`
  - Token URL: `https://api.cloudbeds.com/auth/oauth/token` scopes: `read:item`

## Query parameters

- `limit` integer
- `offset` integer
- `filters` QueryParameterDynamicFilterSchema
  - `filters` DynamicFilterSchema: Represents a logical group of filters with keys like 'and' or 'or'
    - `and` union[]: Logical operator grouping filters or nested logical groups
      - union
        - DynamicFilterFieldSchema: Represents a single filter condition
          - `field` string: The field to apply the filter on
          - `operator` 'greater_than_or_equal' | 'greater_than' | 'less_than_or_equal' | 'less_than' | 'equal' | 'in' | 'not_in' | 'is_null' | 'is_not_null' | 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'starts_with' | 'not_starts_with' | 'ends_with' | 'not_ends_with' | 'is_empty' | 'is_not_empty': The operator to use for the filter
          - `value` union: The value for the filter
            - string
            - string, date-time
            - string, date
            - integer
            - boolean
            - string[]
            - integer[]
            - string[]
            - string[]
        - DynamicFilterSchema (recursive)
    - `or` union[]: Logical operator grouping filters or nested logical groups
      - union
        - DynamicFilterFieldSchema: Represents a single filter condition
          - `field` string: The field to apply the filter on
          - `operator` 'greater_than_or_equal' | 'greater_than' | 'less_than_or_equal' | 'less_than' | 'equal' | 'in' | 'not_in' | 'is_null' | 'is_not_null' | 'equals' | 'not_equals' | 'contains' | 'not_contains' | 'starts_with' | 'not_starts_with' | 'ends_with' | 'not_ends_with' | 'is_empty' | 'is_not_empty': The operator to use for the filter
          - `value` union: The value for the filter
            - string
            - string, date-time
            - string, date
            - integer
            - boolean
            - string[]
            - integer[]
            - string[]
            - string[]
        - DynamicFilterSchema (recursive)

## Headers

- `x-property-id` string, required

## Response `200`

List of custom items.

- CustomItemListResponseSchema
  - `data` CustomItemResponseSchema[], required
    - `id` string, required: Unique identifier for the custom item
    - `name` string, required: Item name
    - `propertyId` string, required: Property ID
    - `sourceId` string, required: Source ID (POS app ID)
    - `sourceName` string, required: Source name (POS app name)
    - `appItemId` string, required: App item ID
    - `sku` string, nullable: SKU
    - `categoryName` string, nullable: Category name
    - `description` string, nullable: Item description
  - `total` integer, required: Total number of items

## Other responses

- `400`: Bad Request response
- `401`: Unauthorized response
- `403`: Forbidden response
- `500`: Internal server error

---

[API](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2.md) - [All operations](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/cloudbeds-api-v2/revisions/69bffac143cc?raw)