Search Customers by Label

Time	Status	User Agent
Retrieving recent requests…

Retrieves the list of customers tagged to a specific label, searching by exact label name.

Example request

curl --location 'https://eu.api.capillarytech.com/v2/customers/labels/search?q=Gold' \
--header 'Authorization: Basic ******'

Prerequisites

Authentication: Basic or O-Auth. For details, see making your first API call.
Default access group.
Rate limiter controls the number of incoming and outgoing traffic of a network.

Retrieves the list of customers tagged to a specific label, searching by exact label name.

Example request

curl --location 'https://eu.api.capillarytech.com/v2/customers/labels/search?q=Gold' \
--header 'Authorization: Basic ******'

Prerequisites

Authentication: Basic or O-Auth. For details, see making your first API call.
Default access group.
Rate limiter controls the number of incoming and outgoing traffic of a network.

👍
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.

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

Query parameters

Field	Type	Required	Description
`q`	string	Required	The exact name of the label to search by. The search is case-insensitive. For example, `Gold` returns all customers tagged with the label named Gold.
`offset`	integer	Optional	Number of records to skip for pagination. Default value: 0.
`limit`	integer	Optional	Maximum number of records to return. `-1` means no limit (fetch all records). Default value: 10.

---------------------	-------------------------------------
URI	`customers/labels/search?q=LabelName`
HTTP method	GET
Authentication	Basic and O-Auth
Pagination supported?	Yes
Batch support	No

Query parameters

Field	Type	Required	Description
`q`	string	Required	The exact name of the label to search by. The search is case-insensitive. For example, `Gold` returns all customers tagged with the label named Gold.
`offset`	integer	Optional	Number of records to skip for pagination. Default value: 0.
`limit`	integer	Optional	Maximum number of records to return. `-1` means no limit (fetch all records). Default value: 10.

Example response

{
    "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": []
}

Response parameters

Parameter	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.

Error and warning codes

Code	Error number	Type	Description
—	—	Error	Invalid input parameters. HTTP 400.
—	—	Error	Authentication failed. HTTP 401.
—	—	Error	Operation not supported for the resource. HTTP 405.
—	—	Error	Internal error. HTTP 500.
Parameter	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.

Error and warning codes

Code	Error number	Type	Description
—	—	Error	Invalid input parameters. HTTP 400.
—	—	Error	Authentication failed. HTTP 401.
—	—	Error	Operation not supported for the resource. HTTP 405.
—	—	Error	Internal error. HTTP 500.

Example request

Prerequisites

Example request

Prerequisites

Note

Resource information

Query parameters

Query parameters

Example response

Response parameters

Error and warning codes

Error and warning codes

200200

400400