Sign in
Customers

Get a list of customers

Retrieves a paginated list of customers in the environment.

get/api/v1/customers

Query parameters

afterstring uuid

Return items that come after this cursor

beforestring uuid

Return items that come before this cursor

limitinteger

Maximum number of items to return

emailstring

Filter by exact customer email address

namestring

Filter by exact customer name

gtstring date-time

Greater than the specified createdAt value

gtestring date-time

Greater than or equal to the specified createdAt value

ltstring date-time

Less than the specified createdAt value

ltestring date-time

Less than or equal to the specified createdAt value

Filter by creation date using range operators: gt, gte, lt, lte

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Response

A paginated list of customer objects.

Changes

Changed in 9 of the 115 revisions of this API.132

  • b876edd1a4fc5See the full diff
    • ●

      added the new CreditOveragePriceCurrencyNotFound enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new InvalidCreditOverageBillingModel enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new InvoicePreviewNotAvailableForDraftContract enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OveragePriceNotSupportedOnAddon enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new OveragePriceRequiresUsageLimit enum value to the response property for the response status

      response-property-enum-value-added

  • 8d63db93d6561See the full diff
    • ●

      added the new STRIPE_INVOICING enum value to the //// response property for the response status

      response-property-enum-value-added

  • 58bb216ff8ce1See the full diff
    • ●

      added the new GovernanceNotEnabled enum value to the response property for the response status

      response-property-enum-value-added

  • 2fee3609afd21See the full diff
    • ●

      added the new AIRWALLEX enum value to the //// response property for the response status

      response-property-enum-value-added

  • 3acd63d6c8612See the full diff
    • ○

      added the new optional header request parameter X-ACCOUNT-ID

      new-optional-request-parameter

    • ○

      added the new optional header request parameter X-ENVIRONMENT-ID

      new-optional-request-parameter

  • 4fa87d66426d1See the full diff
    • ●

      added the new PricingModelNotSupportedByBillingIntegration enum value to the response property for the response status

      response-property-enum-value-added

  • 3dad98111f0d1See the full diff
    • ●

      added the new PREQUEL enum value to the //// response property for the response status

      response-property-enum-value-added

  • 0dece860f6781See the full diff
    • ●

      added the new DataExportIntegrationError enum value to the response property for the response status

      response-property-enum-value-added

  • b181b166a2a52See the full diff
    • ●

      added the new InvalidReceivedSignatureError enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new RECEIVED enum value to the //// response property for the response status

      response-property-enum-value-added