- A valid API key — see Obtain API credentials
| Endpoint | Method | Description |
|---|---|---|
/v1/clients | GET | List all client accounts |
/v1/clients/{id} | GET | Retrieve details for a specific client |
Send GET /v1/clients to retrieve all client accounts visible to the authenticated account.
curl https://api.dev.paradisegateway.net/v1/clients \
-H "APIKEY: YOUR-API-KEY"The response is an array of client objects.
[
{
"id": "CLIENT-3MtwBwLkdIwHu7ix28a3tqPa",
"object": "client",
"dba": "Acme Jewelry",
"parent_id": "CLIENT-01JMRSPCK7XVNP3KS8F2W4T6Y",
"type": "merchant",
"admin_contact_details": {
"first_name": "John",
"last_name": "Doe",
"email": "john.doe@example.com",
"phone": "+15551234567",
"time_zone": "America/New_York"
},
"correlation_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
]Send GET /v1/clients/{id} to get the full details of a single client account.
curl https://api.dev.paradisegateway.net/v1/clients/CLIENT-3MtwBwLkdIwHu7ix28a3tqPa \
-H "APIKEY: YOUR-API-KEY"| Field | Description |
|---|---|
id | Unique client identifier |
dba | Doing-business-as name |
type | merchant or reseller |
parent_id | Parent account in the hierarchy |
admin_contact_details | Primary admin contact information |
The list of clients you see depends on your API key's position in the account hierarchy:
| Your account type | Clients visible |
|---|---|
| Top-level reseller | All merchants and sub-resellers in your hierarchy |
| Sub-reseller | Only merchants under your account |
| Merchant | Only your own client record |