OpenAPI Documentation
OpenAPI Documentation
List dynamic sub-accounts
List the current account's dynamic sub-accounts with pagination. The response includes each account's connection password.
API information
| Item | Value |
|---|---|
| Method | GET |
| Path | /open-api/v1/dynamic/accounts |
| Authentication | X-API-Key |
| Processing | Synchronous |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
resource_status |
string | No | ACTIVE or REMOVED |
user_enabled |
boolean | No | Filter by caller-requested enabled state |
flow_blocked |
boolean | No | Filter by whether use is paused due to traffic-balance conditions |
available |
boolean | No | Filter by whether current conditions for use are met |
sub_account_keyword |
string | No | Sub-account name keyword; 1–255 characters after trimming; case-sensitive substring match; %, _, and \ are matched literally |
page_no |
integer | No | Default 1; greater than or equal to 1 |
page_size |
integer | No | Default 20; range 1–100 |
Boolean query values accept only lowercase true or false.
Request example
curl --request GET \
--url 'https://api-test.puraroute.com/gin/open-api/v1/dynamic/accounts?resource_status=ACTIVE&available=true&page_no=1&page_size=20' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>'
Response fields
data uses the pagination structure. Fields in each list item are the same as Create a dynamic sub-account.
limit_traffic_gb is always a non-null string with six decimal places; 0.000000 means unlimited.
Successful response example
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"id": "1912345678901234567",
"sub_account": "team_a_01",
"password": "example-secret",
"limit_traffic_gb": "10.000000",
"lifetime_used_gb": "1.250000",
"resource_status": "ACTIVE",
"user_enabled": true,
"flow_blocked": false,
"available": true,
"control_pending": false,
"last_usage_sync_time": "2026-08-24T15:20:00.000+08:00",
"create_time": "2026-08-20T10:00:00.000+08:00",
"update_time": "2026-08-24T15:30:00.000+08:00"
}
],
"total": 1,
"page_no": 1,
"page_size": 20
},
"next": null
}
Possible error codes
code |
Description |
|---|---|
400001 |
Authentication failed |
400009 |
A filter, pagination value, or another parameter is invalid |
500000 |
System processing failed; the request did not complete |
The response contains passwords. Do not cache it or write it to ordinary logs.