Retrieve a taxonomy-label

Retrieve a taxonomy-label by its ID.

GET /lucca-api/taxonomy-labels/{id}

Retrieve a taxonomy-label

cURL

curl --request GET \
  --url https://{host}/lucca-api/taxonomy-labels/{id} \
  --header 'Api-Version: <api-version>' \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "8751",
  "type": "taxonomy-label",
  "url": "https://example.ilucca.net/lucca-api/taxonomy-labels/8751",
  "taxonomy": {
    "id": "45",
    "type": "taxonomy",
    "url": "https://example.ilucca.net/lucca-api/taxonomies/45"
  },
  "name": "XL",
  "remoteId": "tshirtSize.extraLarge",
  "createdAt": "2025-01-23T19:45:23Z",
  "lastUpdatedAt": "2025-01-23T19:45:23Z",
  "isArchived": false,
  "lastArchivedAt": null,
  "t9n": {},
  "links": {},
  "embedded": {}
}

This API endpoint is in beta and may be subject to changes, including breaking changes, without prior notice.

Access

OAuth 2.0 scopes

 taxonomies.readonly

or

 taxonomies.readwrite

Authorizations

oAuthoAuth

Authorization · string · header · required

The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.

Headers

Api-Version · enum<string> · required

Set the API version.

Available options: 2024-11-01

Allowed value: "2024-11-01"

Maximum string length: 10

Example:

"2024-11-01"

If-None-Match · string

Only execute the request if current cached version of the resource does not match the one given here.

Example:

"W/q5sd4w2x1c1gfdg"

If-Match · string

Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.

Example:

"W/q5sd4w2x1c1gfdg"

Accept-Encoding · string

List of compression algorithms you support.

Path Parameters

id · string · required

Identifier of the taxonomy-label

Minimum string length: 1

Query Parameters

include · enum<string>[]

Include metadata:

• embedded: the partial or complete representations of related resources (e.g. the employee the resource belongs to).
• links: links to related resources or actions (e.g. approving a leave-request). May be null when you do not have access to the resource (or action).
• totalCount: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.

Read more about expanding responses.

Available options: embedded, links, totalCount

Response

200

application/json

OK

A taxonomy-label resource.

id · string

Minimum string length: 1

type · string

Allowed value: "taxonomy-label"

url · string<uri>

taxonomy · taxonomy-reference · object

Reference to a taxonomy.

Show child attributes

name · string

Minimum string length: 1

remoteId · null | string

Minimum string length: 1

applicabilitySchema · object

JSON schema of the applicable resources this taxonomy label only applies to.

createdAt · string<date-time-offset>

Read-only. UTC timestamp of the moment this object was created.

Example:

"2023-01-23T12:45:23.1234Z"

lastUpdatedAt · string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Example:

"2023-01-23T12:45:23.1234Z"

isArchived · boolean

When false, resource is not archived. When true, resource is archived.

You can update this property in order to set the archival status of the resource.

lastArchivedAt · string<date-time> | null

Read-only. UTC timestamp of the moment this object was last archived through its isArchived property.

Example:

"2023-01-23T12:45:23.1234Z"

t9n · object

Show child attributes

links · object

embedded · object

No embedded resources on a taxonomy-label(s) response. Expect an empty object if embedded are requested.