GET/v1/customers

List customers

Lists customers with their plans, kind and status, a page at a time. Filter by cohort, kind or search text; in a live environment test-money customers appear only when filter.includeTest is set. Needs customers:read.

curl 'https://api.entitler.co/v1/customers' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

Bearer token

Query parameters

Name	Type	Description
`target.team_id`	string
`target.project_id`	string
`target.environment_id`	string
`filter.search`	string
`filter.track.track_id`	string
`filter.cohort_id`	string
`filter.include_test`	boolean
`page_size`	integer (int64)
`after`	string
`kind`	CustomerKind
`sort`	CustomerSortField
`direction`	common.SortDirection

Responses

`200`The ListCustomersResponse message.

ListCustomersResponse

customersarray of ListedCustomerrequired
- customerCustomer
  - attributesarray of CustomerAttributerequired
    - keystringrequired
    - setAtintegerrequired
      at least 0; at most 18446744073709552000
    - setBycommon.Actor
      - idstringrequired
      - typecommon.ActorTyperequired
        One of ACTOR_TYPE_UNSPECIFIED, ACTOR_TYPE_USER, ACTOR_TYPE_KEY, ACTOR_TYPE_SYSTEM.
    - sourceCustomerAttributeSourcerequired
      One of CUSTOMER_ATTRIBUTE_SOURCE_UNSPECIFIED, CUSTOMER_ATTRIBUTE_SOURCE_BUSINESS, CUSTOMER_ATTRIBUTE_SOURCE_CUSTOMER.
    - stateCustomerAttributeStaterequired
      One of CUSTOMER_ATTRIBUTE_STATE_UNSPECIFIED, CUSTOMER_ATTRIBUTE_STATE_FREE_FORM, CUSTOMER_ATTRIBUTE_STATE_VALID, CUSTOMER_ATTRIBUTE_STATE_EXPIRED, CUSTOMER_ATTRIBUTE_STATE_INVALID.
    - untilinteger
      at least 0; at most 18446744073709552000
    - valuestringrequired
    - verifiedAtinteger
      at least 0; at most 18446744073709552000
    - verifiedBycommon.Actor
      - idstringrequired
      - typecommon.ActorTyperequired
        One of ACTOR_TYPE_UNSPECIFIED, ACTOR_TYPE_USER, ACTOR_TYPE_KEY, ACTOR_TYPE_SYSTEM.
  - blockedAtinteger
    at least 0; at most 18446744073709552000
  - blockedReasonCustomerBlockReasonrequired
    One of CUSTOMER_BLOCK_REASON_UNSPECIFIED, CUSTOMER_BLOCK_REASON_PAYMENT_REVERSED.
  - createdAtintegerrequired
    at least 0; at most 18446744073709552000
  - emailstring
  - environmentIdstringrequired
  - externalIdstringrequired
  - idstringrequired
  - identityProviderIdstring
  - marketIdstring
  - moneyCustomerMoneyrequired
    One of CUSTOMER_MONEY_UNSPECIFIED, CUSTOMER_MONEY_REAL, CUSTOMER_MONEY_TEST.
  - namestring
  - projectIdstringrequired
  - revisionintegerrequired
    at least 0; at most 18446744073709552000
  - trackIdstring
  - updatedAtintegerrequired
    at least 0; at most 18446744073709552000
- kindCustomerKindrequired
  One of CUSTOMER_KIND_UNSPECIFIED, CUSTOMER_KIND_RECURRING, CUSTOMER_KIND_ONE_TIME, CUSTOMER_KIND_SCHEDULED, CUSTOMER_KIND_DEFAULT_PLAN, CUSTOMER_KIND_NO_PLAN.
- plansarray of ListedPlanrequired
  - byDefaultbooleanrequired
  - planIdstringrequired
  - planKeystringrequired
  - planNamestringrequired
  - productIdstring
  - versionNumberintegerrequired
    at least 0; at most 18446744073709552000
- statusCustomerStatus
  - atinteger
    at least 0; at most 18446744073709552000
  - featureKeystring
  - periodIdstring
  - planIdstring
  - stateCustomerStaterequired
    One of CUSTOMER_STATE_UNSPECIFIED, CUSTOMER_STATE_NO_PLAN, CUSTOMER_STATE_DEFAULT_PLAN, CUSTOMER_STATE_CANCELLING, CUSTOMER_STATE_SWITCHING_PERIOD, CUSTOMER_STATE_MOVING, CUSTOMER_STATE_LEGACY_PLAN, CUSTOMER_STATE_TRYING_FEATURE, CUSTOMER_STATE_GRANTED, CUSTOMER_STATE_RENEWING, CUSTOMER_STATE_ACTIVE, CUSTOMER_STATE_PAUSED, CUSTOMER_STATE_SUSPENDED, CUSTOMER_STATE_PURCHASE_PENDING, CUSTOMER_STATE_TRIALING.
nextstring
searchReductionsarray of common.SearchReductionrequired

`Error`A refusal, with the HTTP status of its gRPC code.

Error

errorobjectrequired
- codestringrequired
- parametersobjectrequired
  Each value: string
- reasonstringor nullrequired