Skip to content

Read account

GET/v1/account

Returns the platform organization, request livemode, and effective access. API keys report scopes and the service_key role; dashboard sessions report membership permissions. operatingMode describes organization Live access, not the credential's Test/Live mode.

PlatformsAPI key authenticationVersion 2026-09-28

Request example

curl -X GET 'https://api.affinityrx.com/v1/account' \
  -H "Authorization: Bearer $AFFINITY_API_KEY" \
  -H 'Affinity-Version: 2026-09-28'

Response example

These examples show the body structure. Values can differ. Select a status code to see its response.

{
  "account": {
    "allowedReturnUrls": [
      "<string>"
    ],
    "displayName": "<string>",
    "id": "acct_01j2y8m6jcc9tt24af5pw9x1bc",
    "object": "account",
    "slug": "<string>",
    "status": "active",
    "supportEmail": "<string>",
    "websiteUrl": "<string>"
  },
  "livemode": false,
  "scopes": [
    "<string>"
  ],
  "membership": {
    "permissions": [
      "<string>"
    ],
    "role": "administrator",
    "roleName": "<string>",
    "status": "active"
  },
  "operatingMode": "production",
  "user": {
    "email": "<string>",
    "emailVerified": false,
    "image": "<string>",
    "name": "<string>",
    "twoFactorEnabled": false,
    "userId": "<string>"
  }
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 400,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 401,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 403,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 404,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 409,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 422,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}
{
  "code": "<string>",
  "data": "<string>",
  "detail": "<string>",
  "instance": "<string>",
  "requestId": "<string>",
  "status": 429,
  "title": "<string>",
  "traceId": "<string>",
  "type": "<string>"
}

Implementation specification

Use these field types and limits to build your integration. Download the OpenAPI document for the complete contract.

Query parameters

orgIdstring | null
Show schema
Any of · 1: string

string

Pattern: ^acct_[0-7][0-9a-hjkmnp-tv-z]{25}$

Any of · 2: null

null

Headers

Affinity-Versionstring

Selects the HTTP API contract for this request only. When omitted, API-key requests use their service account’s stored version. Does not change the stored default.

Pin requests to 2026-09-28.

Response specifications

200Successful response

application/json

accountobjectrequired

No additional properties

Show account fields
allowedReturnUrlsstring[]required
Show allowedReturnUrls fields

Array items · string

string

displayNamestringrequired
idstringrequired

Pattern: ^acct_[0-7][0-9a-hjkmnp-tv-z]{25}$

objectstringrequired

Allowed: "account"

slugstringrequired
statusstringrequired

Allowed: "active", "pending", "suspended"

supportEmailstring | nullrequired
Show supportEmail fields
Any of · 1: string

string

Any of · 2: null

null

websiteUrlstring | nullrequired
Show websiteUrl fields
Any of · 1: string

string

Any of · 2: null

null

livemodebooleanrequired

True for a Live request; false for a Test request.

scopesstring[] | nullrequired

Effective scopes of the authenticated API key. Null for a dashboard session; use membership.permissions for that session.

Show scopes fields
Any of · 1: string[]

Array items · string

string

Any of · 2: null

null

membershipobjectrequired

No additional properties

Show membership fields
permissionsstring[]required

Effective API scopes for a service key; dashboard permissions for a signed-in member.

Show permissions fields

Array items · string

string

rolestringrequired

Allowed: "administrator", "clinical_reviewer", "developer", "operations", "owner", "viewer", "service_key"

roleNamestringrequired
statusstringrequired

Allowed: "active", "disabled", "invited"

operatingModestringrequired

The organization's Live-access status, independent of this request's livemode.

Allowed: "production", "production_pending", "sandbox", "suspended"

userobjectrequired

No additional properties

Show user fields
emailstringrequired
emailVerifiedboolean | null
Show emailVerified fields
Any of · 1: boolean

boolean

Any of · 2: null

null

imagestring | nullrequired
Show image fields
Any of · 1: string

string

Any of · 2: null

null

namestringrequired
twoFactorEnabledboolean | null
Show twoFactorEnabled fields
Any of · 1: boolean

boolean

Any of · 2: null

null

userIdstringrequired
400HTTP 400

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

401Unauthorized

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

403Forbidden

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

404Not found

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

409Conflict

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

422Validation error

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

429Too many requests

application/json

codestringrequired
dataobject
detailstringrequired
instancestringrequired
requestIdstringrequired
statusintegerrequired

Minimum: 400

Maximum: 599

titlestringrequired
traceIdstring
typestringrequired

Format: uri

Type to search…

↑↓ navigate↵ selectEsc close