customers

List customers

Get a list of customers for the organization

get/customers/

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/customers/
  • Auth: HTTP bearer

Query parameters

limitinteger
offsetinteger
namestring

Search by customer name (case-insensitive, matches anywhere in the name).

status'active' | 'churned'

Filter by customer status. churned: customers marked as churned. active: everyone else.

creationState'draft' | 'active'

Filter by creation state: draft or active.

createdAtFromstring

Only customers created on or after this date. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

createdAtTostring

Only customers created on or before this date. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

externalIdstring

Filter by your external customer ID (exact match).

Response

200

Changes

No recorded changes to this operation across all 1 revision of this API.