Skip to navigation
API ReferenceInboxesAccounts

Get Account

Returns one account held by the inbox. An account elsewhere is a 404. Requires inbox_read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

inbox_idstringRequired
The ID of the inbox.
account_idUUIDRequired
ID of account.

Response

This endpoint returns an object.
account_idUUID
ID of account.
provider_idUUID
ID of provider.
inbox_idstring
The ID of the inbox.
pod_idstring
ID of pod.
organization_idstring
ID of organization.
first_signed_in_atdatetime

Time of first sign-in at provider.

last_signed_in_atdatetime

Time of most recent sign-in at provider.

sign_in_countinteger

Number of sign-ins at provider.

provider_namestringOptional
Display name of provider.
statusenumOptional
Present only while the account is disabled. Absent means the inbox may sign in.
disabled_atdatetimeOptional

Time at which the account was disabled. Present only while status is disabled.

Errors

404
Not Found Error