GET /clients – Retrieves a paginated list of client applications for a specific product.
📥 Request
Headers:
Authorization: Bearer <access_token>(required)
Content-Type: application/json or application/x-www-form-urlencoded(required)
Body:
None
Path Parameters:
None
Query Parameters:
provider: The authentication provider (optional). Defaults to auth0-client if omitted. See ClientProvider.
product: The product identifier associated with the client (required). See ProductKey.
limit: The maximum number of clients to return in the response (optional).
next: The pagination token to retrieve the next set of results (optional).
📤 Response
200 OK – Returns the client PageResponse with data property being an array of Client.
❗ Errors
Status Code
Meaning
When it Happens
400
Bad Request
Missing or invalid fields in request body
401
Unauthorized
Missing or invalid authentication token
404
Not Found
Specified client does not exist
500
Internal Server Error
Unexpected error
Error Response Format
{ "error": "Detailed error message here" }
📦 Examples
📥 Auth0 Request
GET /clients?product=exampleProduct&limit=10&next=paginationToken
📥 Cognito Request
GET /clients?product=exampleProduct&limit=10&provider=cognito-client
📤 Response Example
json { "data": [ { "id":"clientId1", "name":"name1", "callbacks": ["string"], // More fields may be present depending on the provider }, { "id":"clientId2", "name":"name2", "callbacks": ["string"], // More fields may be present depending on the provider } ], "page": { "limit":10, "next":"nextPaginationToken" } }
GET /clients – Retrieves a paginated list of client applications for a specific product.
📥 Request
Headers:
Authorization: Bearer <access_token>(required)Content-Type: application/json or application/x-www-form-urlencoded(required)Body:
Path Parameters:
Query Parameters:
auth0-clientif omitted. See ClientProvider.📤 Response
200 OK– Returns the client PageResponse with data property being an array of Client.❗ Errors
400401404500Error Response Format
📦 Examples
📥 Auth0 Request
📥 Cognito Request
📤 Response Example