APapaleo
MarketSegment

Returns a list of all market segments, filtered by the specified parameters.

<br>You must have at least one of these scopes: 'setup.read, setup.manage'.

get/settings/v1/market-segments

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/settings/v1/market-segments
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: setup.read, setup.manage, admin

Query parameters

propertyIdsstring[]

Return market segments with any of the specified property ids

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

Response

Return market segments.

countinteger required

Total count of items

Example response

{
  "marketSegments": [
    {
      "id": "BUSR",
      "code": "BUSR",
      "name": "Business Groups",
      "description": "Social groups (Weddings etc.)",
      "propertyIds": [
        "MUC",
        "BER"
      ]
    },
    {
      "id": "BPCK",
      "code": "BPCK",
      "name": "Backpackers",
      "description": "Backpackers aged 18-30",
      "propertyIds": [
        "MUC"
      ]
    }
  ],
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.