Skip to content
EntitlerDocs

GET/v1/customers/{external_id}/members

List a customer's members

Lists the customer's members, 50 to a page by default and at most 100, with after to continue and includeRemoved to include removed ones. memberCount counts the live members. Needs customers:read.

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

Credentials

Send any one of these:

  • Bearer token

Path parameters

NameTypeDescription
external_idrequiredstringThe customer's external ID, or me for the customer a customer token or identity token names.

Query parameters

NameTypeDescription
target.team_idstring
target.project_idstring
target.environment_idstring
page_sizeinteger (int64)
afterstring
include_removedboolean

Responses

200The ListCustomerMembersResponse message.

ListCustomerMembersResponse

  • memberCountinteger (int64)required

    at least 0; at most 4294967295

  • memberLimitinteger (int64)

    at least 0; at most 4294967295

  • membersarray of CustomerMemberrequired
    • createdAtintegerrequired

      at least 0; at most 18446744073709552000

    • eraseAtinteger

      at least 0; at most 18446744073709552000

    • externalIdstringrequired
    • idstringrequired
    • namestring
    • removedAtinteger

      at least 0; at most 18446744073709552000

    • updatedAtintegerrequired

      at least 0; at most 18446744073709552000

  • nextstring
  • seatsinteger (int64)

    at least 0; at most 4294967295

ErrorA refusal, with the HTTP status of its gRPC code.

Error

  • errorobjectrequired
    • codestringrequired
    • parametersobjectrequired

      Each value: string

    • reasonstringor nullrequired