v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB

Consumers

List all Consumers

get/v2/control-planes/{controlPlaneId}/core-entities/consumers

Query parameters

sizeinteger

Number of resources to be returned.

offsetstring

Offset from which to return the next set of resources. Use the value of the 'offset' field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using ',' to mean AND or using '/' to mean OR.

custom_idstring

Filter consumers by their custom_id.

filter[name][contains]string

Filter routes by a substring of the name.

filter[name][eq]string

Filter routes by their name.

Response

A successful response listing Consumers

nextstring

URI to the next page (may be null)

offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

Example response

{
  "data": [
    {
      "custom_id": "4200",
      "id": "8a388226-80e8-4027-a486-25e4f7db5d21",
      "tags": [
        "silver-tier"
      ],
      "username": "bob-the-builder"
    }
  ]
}