APapaleo
MarketSegment

Get a market segment.

Get a market segment by id.<br>You must have at least one of these scopes: 'setup.read, setup.manage'.

get/settings/v1/market-segments/{id}

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/{id}
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: setup.read, setup.manage, admin

Path parameters

idstring required

The id of the market segment.

Response

Return market segment.

idstring required

The id of the market segment

codestring required

The code of the market segment

namestring required

The name of the market segment

descriptionstring nullable

The description of the market segment

propertyIdsstring[] nullable

The list of property ids this market segment belongs to

Example response

{
  "id": "BUSR",
  "code": "BUSR",
  "name": "Business Groups",
  "description": "Social groups (Weddings etc.)",
  "propertyIds": [
    "MUC",
    "BER"
  ]
}

Changes

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