v1

latestOpenAPI 3.0.02026-07-14169306521.0 KB
customers

List customers for an app.

Return a paginated list of customers for a specific app, with optional filtering by name, test status, and expiration. Includes customer metadata and instance information.

Required RBAC Policy: kots/app/[:appid]/license/[:licenseid]/read

get/app/{app_id}/customers

Path parameters

app_idstring required

App identifier

Query parameters

pageSizeinteger

Page size

currentPageinteger

Current page

sortColumnstring

Sort column

sortDescboolean

Sort descending

customerNamestring

filter by customer name

IncludeTestboolean
ExpiresBeforestring date-time

Response

ListCustomersResponse contains the JSON customers list

totalCustomersinteger