Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Market Segmentation

Get a list of Market Segmentation Segments.

get/market-segmentation/v1/segments/{enabled}

Path parameters

enabledboolean required

List only enabled segments.

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set. Used for pagination.

limitinteger

The maximum number of items to return in the response. Default is 100.

This parameter should be formatted as a list of strings separated by ;

{
  "filters": {
    "and": [
      {
        "field": "checkin_date",
        "value": "2023-10-19T00:00:00"
      }
    ],
    "or": [
      {
        "field": "checkin_date",
        "value": "2023-10-19T00:00:00"
      }
    ]
  }
}

Headers

x-property-idstring required
Example:1,2,3

A numeric, comma-separated string representing the property IDs, sent in the header.

Response

List of Market Segmentation Segments.

limitinteger
offsetinteger