customers

List customer units (by external customer id)

Lists the customer's units as a flat list, newest last; assemble the tree from parentExternalId (null on the root unit, isRoot: true). Deleted units are hidden unless status=DELETED is given, drafts unless status=DRAFT. Filter by externalType, or by parentExternalId for one level of the tree. Addresses the customer by your external customer id.

get/customers/external/{externalId}/customer-units

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/customers/external/{externalId}/customer-units
  • Auth: HTTP bearer

Path parameters

externalIdstring required

Customer ID from your system, stored on Paid as the customer's externalId.

Query parameters

limitinteger
offsetinteger
status'ACTIVE' | 'DELETED' | 'DRAFT'

Filter by status (default ACTIVE; drafts are listed only with DRAFT).

externalTypestring

Filter by external type.

parentExternalIdstring

Your external ID of the parent unit; lists its direct children.

Response

200

Changes

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