Mindset v3 / Deploy in your app / API Overview

Labels API

Parameters full description

You can find below the full description of Parameters for each POST/PATCH/GET/DELETE methods and also what parameters you can expect from the API responses.

If you want to test the API, please see the Labels API playground.

Labels API reference →

POST - Create a new label (which can be assigned to a context later)

Parameters:

name String

Displayed name of the label

externalId String

Unique Identifier of the label you can optionally provide

showInDiscovery Boolean

Is this label will be visible to the end users ?

PATCH - Updating a Label updatable values

Parameters:

name String

Displayed name of the label

showInDiscovery Boolean

Is this label will be visible to the end users ?

GET - Query the list of labels or get label individually

Parameters:

startAfter - Querying for “the next page” String

Use the startAfter parameter and provide the createdAt string of the last label in the current results set When there are no more results you will receive an empty array in the response and a 404 status code

DELETE - Delete a label by providing its uid

RESPONSE DATA

You will get the same response data when calling POST, PATCH or GET

Note: When retrieving a collection of lables, the response will be an array of objects.

uid String

Mindset internal label uid

externalId String

Unique Identifier of the label you can optionally provide

name String

Displayed name of the label

showInDiscovery Boolean

Will this label be visible to the end users ?

createdAt ISO timestamp

Label creation date