BObookingexperts
DiscountCampaigns

GET discount_campaigns

Changed on

Returns discount campaigns of the administration

get/v3/administrations/{administration_id}/discount_campaigns

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[discount_campaign]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 discount campaigns 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

DiscountCampaignCollectionResponse

Example response

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

Changes

  • ff81bc4fefa9Revision changes
    • info

      endpoint deprecated

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status