BObookingexperts
Subdomains

GET subdomains

Changed on

Returns Subdomains of the organization

get/v3/subdomains

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[subdomain]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[locale_codes]string

Filter on locale_codes

filter[state]string

Filter on state

filter[redirect]string

Filter on redirect

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[brand]string

Filter on brand. Specify a comma separated list of IDs to filter on.

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

SubdomainCollectionResponse

Example response

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

Changes

  • ff81bc4fefa9Revision changes
    • 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