List Customer Labels

Learn how to use the /api/v1/clabels/ API endpoint with the GET method to fetch all customer labels accessible to the requesting manager.

Endpoint

• Method: GET

• URL: /api/v1/clabels/

Description

Show all customer labels the requesting manager has access permissions to.

Examples

Request example (no body / path parameters required):

GET /api/v1/clabels/ HTTP/1.1
Host: api.example.com
Authorization: Bearer <token>

Sample responses

200

{
    "count": 5,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 52,
            "label": "Label1",
            "color": "#2e86de",
            "company": 339
        },
        ...
    ]
}

404

{
  "message": "Ain't no cake like that."
}

Request parameters

• Path parameters: none

• Query parameters: none required for basic listing (see Pagination)

• Header parameters: none required beyond typical auth headers

• Body: none

Pagination

Default pagination is 20 results per page.

• limit — Number of results to return per page. Example: limit=20

• offset — The initial index from which to return the results. Example: offset=21