POST

Query Labels

Retrieves a list of contact labels. Up to 1,000 labels can be returned per request.

For a detailed list of supported operations, see sorting and filtering for labels. To learn how to query labels, see API Query Language.

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
POST
https://www.wixapis.com/contacts/v4/labels/query
Body Params
queryQuery

Query options.

languagestringformat LANGUAGE

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

Response Object
labelsArray <ContactLabel>

List of labels

pagingMetadataPagingMetadata

Details on the paged set of results returned.

Request
cURL
curl -X POST \
  'https://www.wixapis.com/contacts/v4/labels/query' \
  -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": "2021-04-20T14:02:20Z",
      "updatedDate": "2021-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
400Invalid Argument

There are 6 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?