Rate limiter controls the number of incoming and outgoing traffic of a network.
Authentication verifies the identity of the current user or integration. See Introduction > Authentication (Merchant Setup on Admin Portal) for more details.

👍
Note
For detailed information about the APIs and for hands-on testing, refer to the API overview documentation and step-by-step guide on making your first API call.

Prerequisites

Basic and O-Auth Authentication
Default access group

Resource information

URI	customers/labels/search?q=LabelName
HTTP method	GET
Authentication	Basic and O-Auth
Pagination supported?	Yes
Rate limit	Demo and testing clusters: 1000 requests per minute per API key. Other organizations: Rate limit is brand-specific.
Batch support	NO

Example request

curl --location 'https://eu.api.capillarytech.com/v2/customers/labels/search?q=r' \
--header 'Authorization: Basic ******' \
--header 'Cookie: _cfuvid=A7RRUmy8v5VI5rJd.mVzhbsc4Ab_bYLSUImEI2T6GuE-1757664909131-0.0.1.1-604800000'

Query parameters

Parameter	Data Type	Description
`q`*	String	Specify the label name by which you want to fetch customers. You can also pass a partial string. For example `pre` to fetch customers in all labels that start with `pre`. The search query values are case-sensitive
`offset`	Integer	Number of records to skip for pagination. Default value: 0
`limit`	Integer	Maximum number of records to return. `-1` means no limit (fetch all records). Default value: 10

Response parameters

Parameter	Data Type	Description
`pagination`	Object	Pagination details. The maximum number of records to return per page. Defaults to 10 if not specified.
`- limit`	Integer	Number of records returned per page.
`- offset`	Integer	Offset used for pagination.
`- total`	Integer	Total number of records available.
`data`	Array	Array of user data objects.
`- userId`	Integer	Unique identifier of the user.
`- customerLabels`	Array	Labels assigned to this user.
`-- orgId`	Integer	Organization ID where the label belongs.
`-- labelId`	Integer	Unique ID of the label.
`-- userId`	Integer	Unique identifier of the user.
`-- labelName`	String	Name of the label assigned to the user.
`warnings`	Array	Any warnings returned by the API.
`errors`	Array	Any errors returned by the API.

{
    "pagination": {
        "limit": 10,
        "offset": 0,
        "total": 2
    },
    "data": [
        {
            "userId": 564341182,
            "customerLabels": [
                {
                    "orgId": 100737,
                    "labelId": 17243,
                    "userId": 564341182,
                    "labelName": "real"
                }
            ]
        },
        {
            "userId": 565032200,
            "customerLabels": [
                {
                    "orgId": 100737,
                    "labelId": 17243,
                    "userId": 565032200,
                    "labelName": "real"
                }
            ]
        }
    ],
    "warnings": [],
    "errors": []
}

Error code

Error code	Description
400	Invalid input parameters.
401	Authentication failed
405	Operation not supported for the resource
500	Internal error