v1

latestOpenAPI 3.1.02026-07-24700259.3 KB

SUBACCOUNTS

View subaccounts

Returns any subaccounts that match search criteria

post/subaccounts/search

Request body

fuzzy_searchboolean

Determines if search terms match complete field values and are case sensitive (false) or partial fields and are case insensitive (true). Default: true

search_termsstring[]

Return subaccounts with one or more of the strings in the following array. Note: See 'fuzzy_search' for impact on case sensitivity

statesstring

Controls which states you will be searched Valid values: all, active, closed, suspended

sort_directionstring

Sort direction, sorts either asc or desc by subaccount name

page_sizeinteger

Number of subaccounts to retrieve per call

continue_tokenstring

A token provided by a prior call to this endpoint, passing this will cause it to fetch the next page of results

Response

List of subaccounts

request_idstring required

Example response

{
  "request_id": "0ef3f48a-2cfb-11eb-aee9-408d5cce2644",
  "data": {
    "total_count": 1,
    "subaccounts": [
      {
        "email": "test@gmail.com",
        "state": "Active",
        "plan_size": 10000,
        "plan_remaining": 10000,
        "name": "Matt & Juanita"
      }
    ]
  }
}