Luxor PlatformAPI DocumentationMining PoolSubaccounts

Get subaccounts

Returns a list of all subaccounts associated to a Workspace.

GET
/v2/pool/subaccounts

Authorization

LuxorAPIKey
authorization<token>

Use your API key here.

In: header

Query Parameters

site_id?|
page_number?integer
Range1 <= value
Default1
page_size?integer
Range1 <= value
Default10

Response Body

application/json

application/json

curl -X GET "https://example.com/v2/pool/subaccounts"
{  "subaccounts": [    {      "id": 1,      "name": "my_subaccount",      "site": {        "id": "b0a5fad8-0e09-4f10-ac20-ccd80fb2d138",        "name": "My Site",        "url": "/v2/workspace/sites/b0a5fad8-0e09-4f10-ac20-ccd80fb2d138"      },      "created_at": "2019-08-24T14:15:22Z",      "url": "/v2/pool/subaccounts/my_subaccount"    }  ],  "pagination": {    "page_number": 1,    "page_size": 1,    "item_count": 0,    "previous_page_url": null,    "next_page_url": null  }}
{  "statusCode": 400,  "code": "FST_ERR_VALIDATION",  "error": "Bad Request",  "message": "body/end_date Required"}