Management API
...
Customer
Accounts

List Customer Accounts

4min

Show all customer accounts the requesting manager has access permissions to.

URL: /api/v1/customer-accounts/

Method: GET

Query Parameters:

Pagination:

Default pagination is 20 results per page.

  • limit - Number of results to return per page.
    • Example: limit=20
  • offset - The initial index from which to return the results.
    • Example: offset=21

Filtering:

The results can be filtered by various attributes on customer account or related to the customer account.

Possible filters:

  • code
  • name
  • description
  • phone
  • address
  • email
  • reference
  • metadata

Success Response:

Code: 200 OK

Content Examples:

JSON




Updated 23 Apr 2024
Doc contributor
Doc contributor
Did this page help you?
PREVIOUS
Import Customers from CSV
NEXT
Retrieve Customer Account
Docs powered by Archbee