Skip to main content

Get customers list with filtering and pagination

GET 
/api/v1/customers

This endpoint retrieves a paginated list of customers with support for filtering, sorting, and searching.

Authentication: Requires a Private API Key (sk_*) passed in the X-API-Key header.

Query Parameters:

  • page: Page number (default: 1, minimum: 1)
  • pageSize: Number of items per page (default: 20, maximum: 100)
  • search: Search by customer name, email, or phone number
  • isVerified: Filter by phone verification status (true/false)
  • createdFrom: Filter customers created after this date (ISO 8601 format)
  • createdTo: Filter customers created before this date (ISO 8601 format)
  • sortBy: Sort field (createdAt, name, email, etc.)
  • sortOrder: Sort direction (asc, desc)

Use Cases:

  • Building customer management dashboards
  • Exporting customer data for analytics
  • Customer search and filtering interfaces
  • Bulk customer operations and reporting

Error Scenarios:

  • 400 BAD REQUEST: Invalid pagination parameters (Error code: INVALID_PAGINATION)
  • 401 UNAUTHORIZED: Invalid or missing API key (Error code: INVALID_API_KEY)
  • 403 FORBIDDEN: API key doesn't have access to this store (Error code: NO_STORE_ACCESS)

Request​

Responses​

Customers list retrieved successfully with pagination metadata