BObookingexperts
Promotions

GET promotions

Changed on

Returns promotions of the administration

get/v3/administrations/{administration_id}/promotions

Request

Path parameters

administration_idstring required

Administration ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id

fields[promotion]string

Fieldset. Specify a comma separated list of attributes to return

filter[id]string

Filter on ID

filter[name]string

Filter on name

filter[description]string

Filter on description

include_archivedboolean

When true, archived promotions are included in the response

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

PromotionCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "promotion"
    }
  ]
}

Changes