Get Tags

get

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tags/tenant/tenant-id/{tenantId}/tags

Path Params

tenantId

string

required

Tenant identifier.

Query Params

limit

string

Limit. Default value is 20.

startingAfter

string

Starting after is an object ID that defines your place in the list.

endingBefore

string

Object identifier that defines your place in the list.

level

string

enum

Level.

Allowed:

brandCode

string

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

childOf

string

Parent tag name (only for "tag" and "subtag" levels).

locale

string

enum

Locale in [ISO 639-1]-[ISO 3166-1] format.

Allowed:

displayValue

string

The value to display for a given locale. displayValue entities allow for built-in translation. Values can be set depending on the possible locales, so that the associated information can be displayed in the appropriate language for a locale.

Response

200

The Tags.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!