BObookingexperts
Brands

GET brands

Changed on

Returns Brands of the organization

get/v3/brands

Request

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, created_at, updated_at

fields[brand]string

Fieldset. Specify a comma separated list of attributes to return

filter[id]string

Filter on ID

filter[name]string

Filter on name

filter[google_tag_manager_mode]string

Filter on google_tag_manager_mode

filter[google_tag_manager_key]string

Filter on google_tag_manager_key

filter[google_tag_manager_host]string

Filter on google_tag_manager_host

filter[google_tag_manager_path]string

Filter on google_tag_manager_path

filter[tagging_server_host]string

Filter on tagging_server_host

filter[google_maps_key]string

Filter on google_maps_key

filter[primary_color]string

Filter on primary_color

filter[secondary_color]string

Filter on secondary_color

filter[text_color]string

Filter on text_color

filter[background_color]string

Filter on background_color

filter[header_text_color]string

Filter on header_text_color

filter[header_background_color]string

Filter on header_background_color

filter[cookie_consent]string

Filter on cookie_consent

filter[cookie_consent_description]string

Filter on cookie_consent_description

filter[cookie_consent_buttons_layout]string

Filter on cookie_consent_buttons_layout

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

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

BrandCollectionResponse

Example response

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

Changes

  • ff81bc4fefa9Revision changes
    • info

      added the new optional query request parameter filter[created_at]

    • info

      added the new optional query request parameter filter[updated_at]

    • 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