List customers

GET

/customers

const url = 'https://example.com/v2/customers?status=ACTIVE&page=1&limit=20';
const options = {method: 'GET', headers: {'X-CowriePay-Key': '<X-CowriePay-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/v2/customers?status=ACTIVE&page=1&limit=20' \
  --header 'X-CowriePay-Key: <X-CowriePay-Key>'

Paginated, newest first. Scoped to the API key’s network. Requires customers:read.

Authorizations

ApiKeyAuth

Parameters

Query Parameters

status

string

Allowed values: ACTIVE ARCHIVED

external_ref

string

Exact-match lookup by your id.

page

integer

default: 1 >= 1

limit

integer

default: 20 >= 1 <= 100

Responses

200

Paginated customers

application/json

object

data

Array<object>

object

string format: uuid

external_ref

Your opaque identifier for this end-user (never PII). Unique within your workspace + mode.

string

label

Optional display name you chose (e.g. “Alice”). Not for PII.

string | null

metadata

Optional free-form object, opaque to CowriePay.

object | null

status

ARCHIVED retires the sub-account label; it does NOT stop monitoring its addresses.

string

Allowed values: ACTIVE ARCHIVED

created_at

string format: date-time

updated_at

string format: date-time

total

integer

page

integer

limit

integer

Example

{
  "data": [
    {
      "external_ref": "user_8f3a2c",
      "status": "ACTIVE"
    }
  ]
}