APapaleo
AgeCategory

Get an age category

Get an age category by id.<br>You must have at least one of these scopes: 'settings.read, setup.read, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.age_categories.read'.

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

Path parameters

idstring required

The id of the age category.

Query parameters

languagesstring[]

'all' or comma separated list of two-letter language codes (ISO Alpha-2)

Response

Return all the age category data.

idstring required

The age category id

codestring required

The code for the age category

propertyIdstring required

The id of the property for which the age category will be created

nameobject required

The name for the age category

minAgeinteger required

The minimum age for the age category. The specified value is included in the age range

maxAgeinteger required

The maximum age for the age category. The specified value is included in the age range

Example response

{
  "id": "MUC-BABY",
  "code": "BABY",
  "propertyId": "MUC",
  "name": {
    "en": "Baby"
  },
  "minAge": 0,
  "maxAge": 1
}

Changes

No recorded changes to this operation across all 5 revisions of this API.