Labels

GET label

Returns the label for the given ID

get/v3/labels/{context_model}/{id}

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

idstring required

Resource ID

Query parameters

fields[label]string

Fieldset. Specify a comma separated list of attributes to return

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

LabelResponse

Example response

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

Changes

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