Accounts

List accounts

get
Authorizations
Query parameters
pageinteger · min: 1Optional

Which page to fetch

Default: 1
pageSizeinteger · min: 1 · max: 30Optional

Page size to use

Default: 30
statusstring · enumOptional

Account status

Possible values:
namestringOptional

Search by matching name

governanceTypestring · enumOptional

Account governance type

Possible values:
allowedActionstring · enumOptional

Filter accounts by allowed action for current user

Possible values:
sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:
sortOrderstring · enumOptional

Sort order

Default: ascPossible values:
Responses
200
Successful response
application/json
get
GET /rest/accounts HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "legacyId": 1,
      "name": "text",
      "currency": "text",
      "index": 1,
      "derivationPath": "text",
      "status": "ACTIVE",
      "createdAt": "text",
      "updatedAt": "text",
      "asset": {
        "type": "BITCOIN_LIKE",
        "xpub": "text"
      },
      "governance": {
        "type": "CLASSIC",
        "policyId": "text"
      }
    }
  ]
}

Get a single account

get
Authorizations
Path parameters
idstringRequired

Id of the target account

Responses
200
Successful response
application/json
get
GET /rest/accounts/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "legacyId": 1,
  "name": "text",
  "currency": "text",
  "index": 1,
  "derivationPath": "text",
  "status": "ACTIVE",
  "createdAt": "text",
  "updatedAt": "text",
  "asset": {
    "type": "BITCOIN_LIKE",
    "xpub": "text"
  },
  "governance": {
    "type": "CLASSIC",
    "policyId": "text"
  }
}
PreviousUsersNextTransactions