v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Groups [Pilot]

List groups

Retrieve a paginated list of combo properties and property variants (groups) for the account. The term group refers to both types: COMBO (combo properties) and DUPLICATES (property variants). Supports optional filtering by group type.

Check out our Help Center to learn more about these property types.

get/properties-api/groups/group

Query parameters

type'COMBO' | 'DUPLICATES'

Example:COMBO

Optional filter by group type

offsetinteger

Pagination offset

limitinteger

Example:50

Pagination limit (1-200)

Response

List of groups retrieved successfully

offsetnumber

limitnumber

hasNextPageboolean

Example response

{
  "limit": 50,
  "groups": [
    {
      "id": "63baba9c5c25ccae55958321",
      "type": "COMBO",
      "primaryId": "63baba9c5c25ccae5595832b",
      "createdAt": "2024-01-01T12:00:00.000Z",
      "updatedAt": "2024-01-02T12:00:00.000Z"
    }
  ]
}