BObookingexperts
Labels

GET labels

Returns labels of the organization

get/v3/labels/{context_model}

Request

Path parameters

context_modelstring required

Target context model on which the returned labels can be applied. One of: contact, sale, inventory_object, owner, reservation, sales_listing

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, name

fields[label]string

Fieldset. Specify a comma separated list of attributes to return

filter[id]string

Filter on ID

filter[name]string

Filter on name

filter[background]string

Filter on background

filter[foreground]string

Filter on foreground

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

LabelCollectionResponse

Example response

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

Changes

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