Skip to main content
GET
/
v1
/
account
Get a list of accounts
curl --request GET \
  --url https://{base_url}/v1/account
[
  {
    "id": "<string>",
    "email": "<string>",
    "name": "<string>",
    "provider": "AccountToken",
    "given_name": "<string>",
    "family_name": "<string>",
    "users": [
      {
        "id": "<string>",
        "org_id": "<string>",
        "account_id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "state": "Active",
        "roles": [
          "AppGuest"
        ],
        "created_at": "<string>",
        "profile_picture": "<string>",
        "job_position_name": "<string>",
        "job_position_description": "<string>"
      }
    ],
    "roles": [
      "AppGuest"
    ]
  }
]

Query Parameters

​
page
number

The absolute page number to fetch (1-based).

​
page_size
number

Number of items per page. Default is 20.

​
page_order
string

Sort order for pagination. Options: ASC, DESC. Default is ASC.

​
after
string

The cursor or value to paginate after (for relative pagination).

​
before
string

The cursor or value to paginate before (for relative pagination).

​
first
number

Limits the result to the first N items (after cursor).

​
last
number

Limits the result to the last N items (before cursor).

​
total_count
boolean

Include the total count in the response.

Response

200 - application/json

List of accounts

​
id
string
required
​
email
string
required
​
name
string
required
​
provider
enum<string>
required
Available options:
AccountToken,
UserToken,
AccountSession,
UserSession,
Credentials,
Mock,
Google,
Microsoft,
Confluence,
SharePoint
​
given_name
string
​
family_name
string
​
users
object[]
​
roles
enum<string>[]
Available options:
AppGuest,
AppMember,
AppAdmin,
AppOwner,
Basic,
Developer,
Admin,
SuperAdmin