Skip to main content

List Accounts

Deprecated

This endpoint is deprecated. Use GET /v3/customers, which also filters by verification status and creation date, and sorts. It keeps working while integrations move; see Versioning.

This endpoint returns a paginated list of accounts with optional filters.

Takes a workspace-scoped API key. An account-scoped key is refused with 403.

Authorization:

Every request is signed with your API key: a short-lived JWT, signed with your private key, sent in one header on /v3/* and /api/v2/* alike.

Headers:
Authorization: APIKey {SIGNED_JWT}

How to build and sign the JWT: Authentication.

Endpoint

GET

/api/v2/accounts

Query Parameters​

ParameterTypeDescription
pageintPage number (default: 1).
limitintNumber of items per page (default: 100).
statusstringFilter by status: pending, active, paused or closed.
searchstringSearch by email or account name. (min 3 characters)

Response Sample​

{
"page": 1,
"limit": 20,
"total": 1,
"data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"reference": "client-reference-123",
"accountType": "individual",
"email": "jwick@example.com",
"accountName": "Wick's Account",
"firstName": "John",
"lastName": "Wick",
"status": "pending",
"createdAt": "2025-04-07T15:32:01.411Z",
"updatedAt": "2025-04-07T15:32:01.411Z"
}
]
}

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!