Sign in
Members

List Members

Lists the members of an account. A member is one buyer's relationship with the account, regardless of how many memberships they hold.

get/members

Query parameters

account_idstring

The account to list members for (biz_ tag). Defaults to the account the credential acts as.

access_level'no_access' | 'admin' | 'customer'

Filter by what the member can reach on the account.

status'joined' | 'left'

Filter by whether the member is still part of the account.

user_idsstring[]

Only return members whose users match these user_ identifiers.

[
  "user_xxxxxxxxxxxxxx"
]
querystring

Search members by name or username. An exact email address also matches when the credential holds the member:email:read scope.

created_afterstring

Only members who joined after this ISO 8601 timestamp.

created_beforestring

Only members who joined before this ISO 8601 timestamp.

order'created_at' | 'joined_at' | 'last_accessed_at' | 'usd_total_spent'

Sort field.

direction'asc' | 'desc'

Sort direction.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

members listed

Example response

{
  "data": [
    {
      "access_level": "customer",
      "account_id": "biz_xxxxxxxxxxxxxx",
      "created_at": "2026-01-01T12:00:00.000Z",
      "id": "mber_xxxxxxxxxxxxxx",
      "joined_at": "2026-01-01T12:00:00.000Z",
      "last_accessed_at": "2026-01-01T12:00:00.000Z",
      "phone_number": "+xxxxxxxxxxx",
      "status": "joined",
      "user": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Dana Whitfield",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "danawhitfield"
      }
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 3 of the 74 revisions of this API.201531

  • 16c82685be351See the full diff
    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f1020c3ecda43See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 60bbb4a6ffbc201527See the full diff
    • ▲

      the query request parameter access_level was restricted to a list of enum values

      request-parameter-became-enum

    • ▲

      the query request parameter direction was restricted to a list of enum values

      request-parameter-became-enum

    • ▲

      the query request parameter order was restricted to a list of enum values

      request-parameter-became-enum

    • ▲

      for the query request parameter direction, default value desc was added

      request-parameter-default-value-added

    • ▲

      for the query request parameter first, default value 20 was added

      request-parameter-default-value-added

    • ▲

      for the query request parameter order, default value created_at was added

      request-parameter-default-value-added

    • ▲

      added subschema #2 to the // response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      the // response's property format changed from date-time to no format for status

      response-property-type-changed

    • ▲

      the // response's property format changed from date-time to no format for status

      response-property-type-changed

    • ▲

      the // response's property type changed from object null to no type for status

      response-property-type-changed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property // from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ▲

      removed the required property /// from the response with the status

      response-required-property-removed

    • ●

      for the query request parameter first, the max was set to 100.00

      request-parameter-max-set

    • ●

      for the query request parameter last, the max was set to 100.00

      request-parameter-max-set

    • ●

      deleted the query request parameter company_id

      request-parameter-removed

    • ●

      deleted the query request parameter most_recent_actions

      request-parameter-removed

    • ●

      deleted the query request parameter plan_ids

      request-parameter-removed

    • ●

      deleted the query request parameter product_ids

      request-parameter-removed

    • ●

      deleted the query request parameter promo_code_ids

      request-parameter-removed

    • ●

      deleted the query request parameter statuses

      request-parameter-removed

    • ●

      deleted the query request parameter user_ids

      request-parameter-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ○

      api operation id listMember removed and replaced with listMembers

      api-operation-id-removed

    • ○

      the security scope member:email:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    • ○

      the security scope member:phone:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    • ○

      added the new optional header request parameter Api-Version-Date to all path's operations

      new-optional-request-default-parameter-to-existing-path

    • ○

      added the new optional query request parameter account_id

      new-optional-request-parameter

    • ○

      added the new optional query request parameter status

      new-optional-request-parameter

    • ○

      added the new enum value admin to the query request parameter access_level

      request-parameter-enum-value-added

    • ○

      added the new enum value asc to the query request parameter direction

      request-parameter-enum-value-added

    • ○

      added the new enum value created_at to the query request parameter order

      request-parameter-enum-value-added

    • ○

      added the new enum value customer to the query request parameter access_level

      request-parameter-enum-value-added

    • ○

      added the new enum value desc to the query request parameter direction

      request-parameter-enum-value-added

    • ○

      added the new enum value joined_at to the query request parameter order

      request-parameter-enum-value-added

    • ○

      added the new enum value last_accessed_at to the query request parameter order

      request-parameter-enum-value-added

    • ○

      added the new enum value no_access to the query request parameter access_level

      request-parameter-enum-value-added

    • ○

      added the new enum value usd_total_spent to the query request parameter order

      request-parameter-enum-value-added

    • ○

      for the query request parameter access_level, the type was generalized from no type to string

      request-parameter-type-generalized

    • ○

      for the query request parameter created_after, the type was generalized from string null to string, and format from date-time to no format

      request-parameter-type-generalized

    • ○

      for the query request parameter created_before, the type was generalized from string null to string, and format from date-time to no format

      request-parameter-type-generalized

    • ○

      for the query request parameter direction, the type was generalized from no type to string

      request-parameter-type-generalized

    • ○

      for the query request parameter order, the type was generalized from no type to string

      request-parameter-type-generalized

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      removed the non-success response with the status

      response-non-success-status-removed

    • ○

      removed the drafted enum value from the // response property for the response status

      response-property-enum-value-removed

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.