GET

Get Label

Retrieves a label by the specified label key.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings Services and Settings
Manage Contact Labels
Manage Portfolio
Manage Members and Contacts - all permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/contacts/v4/labels/{key}
Path Params
keystringRequired

Label key.

key is generated when the label is created. It can't be modified, even if displayName is updated.

Query Params
languagestring

Language for localization. 2-letter language code in ISO 639-1 alpha-2 format.

Response Object
labelLabel

The specified label.

Get Label
Request
cURL
curl -X GET 'https://www.wixapis.com/contacts/v4/labels/custom.my-label' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: <AUTH>'
Response
JSON
{
  "label": {
    "namespace": "custom",
    "key": "custom.my-label",
    "displayName": "My Label",
    "labelType": "USER_DEFINED",
    "createdDate": "2020-04-20T14:02:20Z",
    "updatedDate": "2020-04-20T14:02:20Z"
  }
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?