---
title: "List custom property values"
method: GET
path: "/v1/custom-properties/groups/{groupId}/values"
tags: ["v1 - Custom Properties"]
---

# List custom property values

`GET /v1/custom-properties/groups/{groupId}/values`

## Request

- Base URL: `https://light.inc` (the document declares no server; this is the origin it was published from)
- URL: `https://light.inc/v1/custom-properties/groups/{groupId}/values`
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer

Returns a paginated list of custom property values

## Path parameters

- `groupId` string, uuid, required

## Query parameters

- `sort` string: Sort string in the format `field:direction`. To provide multiple sort fields, separate them with commas. Available directions: `asc`, `desc`. Available fields: `label`, `value`, `createdAt`.
- `filter` string: Filter string in the format `field:operator:value`. To provide multiple filters, separate them with commas. Available operators: `eq`, `ne`, `in`, `not_in`, `gt`, `gte`, `lt`, `lte`. - For `in` and `not_in` operators, provide multiple values separated by the pipe character (`|`). Available fields: `id`, `label`, `value`, `createdAt`, `updatedAt`.
- `limit` integer
- `offset` integer
- `cursor` string

## Response `default`

default response

- ExternalPaginatedResponseV1ModelExternalCustomPropertyValueV1Model
  - `records` ExternalCustomPropertyValueV1Model[]: List of records for the current page
    - `id` string, uuid: Unique identifier for the object
    - `groupId` string, uuid: ID of the custom property group
    - `groupInternalName` string: Internal name of the custom property group
    - `companyId` string, uuid: ID of the company
    - `internalName` string: Internal name of the custom property value
    - `label` string: Label of the custom property value
    - `context` string, nullable: Context/description of the custom property value
    - `createdAt` string, date-time: Timestamp when the custom property value was created
    - `updatedAt` string, date-time: Timestamp when the custom property value was last updated
  - `hasMore` boolean: Boolean flag indicating if there are more records available
  - `total` integer, nullable: Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination.
  - `nextCursor` string, nullable: Cursor for fetching the next page (only for cursor pagination)
  - `prevCursor` string, nullable: Cursor for fetching the previous page (only for cursor pagination)

---

[API](https://skmtc.dev/light/apis/light-api.md) - [All operations](https://skmtc.dev/light/apis/light-api/llms.txt) - [OpenAPI document](https://skmtc.dev/light/apis/light-api/revisions/84f51306f648?raw)