v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Search Customers by Label

Retrieves the list of customers tagged to a specific label. Searches by exact label name, case-insensitive. By default you will see a maximum of 10 records.

get/customers/labels/search?q={LabelName}

Query parameters

qstring required

Specify the label name by which you want to fetch customers. You can also pass partial string. For example pre to fetch customers in all labels that starts with pre.

Response

200

Example response

{
  "pagination": {
    "limit": 10,
    "total": 2
  },
  "data": [
    {
      "userId": 316481804,
      "customerLabels": [
        {
          "labelId": 3,
          "userId": 316481804,
          "labelName": "book"
        }
      ]
    }
  ]
}