GET

List Labels

Lists all contact labels for a site.

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
Query Params
labelTypestring

Filter for labels of the specified type.

namespacestring

Filter for labels in the specified namespace.

startsWithstring

Filter for labels where displayName starts with the specified case-sensitive string.

sort.fieldNamestringmaxLength 3000

Name of the field to sort by.

sort.orderstring

Sort order.

Default: ASC.

paging.limitintegerminimum 0format int32

Number of items to return.

Defaults to 1000.
Maximum: 2000.

paging.offsetintegerminimum 0format int32

Number of items to skip in the current sort order.

languagestring
Response Object
labelsArray <ContactLabel>

List of labels.

metadataMetadata

Metadata for the page of results.

Request
cURL
curl -X GET \
  'https://www.wixapis.com/contacts/v4/labels' \
  -H 'Authorization: <AUTH>'
Response
JSON
{
  "labels": [
    {
      "namespace": "custom",
      "namespaceDisplayName": "Labels",
      "key": "custom.my-label",
      "displayName": "My Label",
      "labelType": "USER_DEFINED",
      "createdDate": "2020-04-20T14:02:20Z",
      "updatedDate": "2020-04-20T14:02:20Z"
    },
    {
      "namespace": "custom",
      "namespaceDisplayName": "Labels",
      "key": "custom.another-label",
      "displayName": "Another Label",
      "labelType": "USER_DEFINED",
      "createdDate": "2020-04-20T14:02:20Z",
      "updatedDate": "2020-04-20T14:02:20Z"
    },
    {
      "namespace": "contacts",
      "namespaceDisplayName": "Labels",
      "key": "contacts.customers",
      "displayName": "Customers",
      "labelType": "SYSTEM"
    },
    {
      "namespace": "contacts",
      "namespaceDisplayName": "Labels",
      "key": "contacts.contacted-me",
      "displayName": "Contacted Me",
      "labelType": "SYSTEM"
    }
  ],
  "metadata": {
    "count": 4,
    "offset": 0,
    "total": 4
  }
}
Errors

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

Did this help?