Skip to main content
GET
/
accounts
Get Accounts
curl --request GET \
  --url https://access.utgl.io/v1/accounts \
  --header 'Authorization: Basic <encoded-value>'
{
  "prevPageToken": "<string>",
  "nextPageToken": "<string>",
  "accounts": [
    {
      "id": "<string>",
      "xid": "<string>",
      "xmetadata": {},
      "name": "<string>",
      "accountNumber": "<string>",
      "description": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
accountId
string

Search results by account id(s)

​
name
string

Search results by account name

​
search
string

Search results by account name and account number

​
xid
string[]

Filter by one or more xid

​
pageSize
number

Limits the number returned items Some collections have a upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used. If no page size is provided, the collection will determine the page size itself.

Required range: x >= 1
​
pageToken
string
Example:

"aWVHZWV5OVgK"

Response

200 - application/json

Retrieve a paginated collection of accounts

​
prevPageToken
string

Opaque page token to retrieve next or previous set of results.

​
nextPageToken
string

Opaque page token to retrieve next or previous set of results.

​
accounts
object[]