Sign in

v1

latestOpenAPI 3.0.02026-07-14169306521.0 KB
customers

Search all customers for a given team context.

Search for customers within a team using flexible query parameters, including name, type, channel, and status. Supports pagination, sorting, and filtering by customer attributes.

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

post/customers/search

Request body

adoption_rate_filterstring
app_idstring

The app id to limit search. If not provided, customers for all apps will be searched.

channel_namesstring[]

Restrict search to customers in the specified channels.

expires_beforestring date-time
include_activeboolean

When set to true, active customers will be included in the search results. Default is false.

include_archivedboolean

When set to true, archived customers will be included in the search results. Default is false.

include_communityboolean

When set to true, community customers will be included in the search results. Default is false.

include_devboolean

When set to true, dev customers will be included in the search results. Default is false.

include_inactiveboolean

When set to true, inactive customers will be included in the search results. Default is false.

include_paidboolean

When set to true, paid customers will be included in the search results. Default is false.

include_testboolean

When set to true, test customers will be included in the search results. Default is false.

include_trialboolean

When set to true, trial customers will be included in the search results. Default is false.

instance_previewboolean

When set to true, more detailed information for active and inactive customer instances will be provided in the search results. If false, active and inactive instances will be combined into a single list. Default is false.

license_or_service_accountstring

Search by license ID or Enterprise Portal service account token. When provided, this will find the specific customer associated with the license ID or service account token. This field accepts both actual license IDs and Enterprise Portal service account tokens as license substitutes.

max_instancesinteger

The maximum number of instances to return for each customer. Default is 3.

offsetinteger

The number of pages to skip.

page_sizeinteger

The number of customers to return per page.

querystring

The search query. By default this value will be used to search customers by name. When value is in the key:value format, it can be used to search specific fields. The following fields are supported. name: search by customer name. For example name:acme. This search is fuzzy and case insensitive. type: search by customer type. Possible values are prod, trial, dev, and community. For example type:trial. airgap: search by airgap status. Possible values are true and false. For example airgap:true. channels.name: search by channel name. For example channels.name:stable. This search is fuzzy and case insensitive. customId: search by custom id. For example customId:123. This is an exact match search. email: search by customer email. For example email:bob@replicated.com. This is an exact match search.

sort_directionstring

The sort direction. Possible values are asc and desc. Default is desc if sort_field is specified.

sort_fieldstring

The field to sort by. Possible values are expiresAt, createdAt, name, type. There is no default value.

Response

SearchTeamCustomersResponse contains the list of licenses

querystring
total_hitsinteger