Get user info

This endpoint allows API users to get information about the current user.

get/user

Request

Response

Details of the user account.

idstring

ID of the user.

prointeger

Legacy flag of a paid account: 1 or 0.

typeinteger

Account type.

activestring

Whether the account is active: 1 for active, 0 for inactive.

emailsstring[]

Email addresses of the user.

localestring

Language of the account, for example en.

createdstring

Unix timestamp of when the account was created, as a string.

creditsinteger

Number of document credits.

settingsobject

Account settings as boolean flags, keyed by setting name. The set of settings depends on the account and plan.

verifiedboolean

Whether the email address of the user is verified.

appleappsboolean

Whether the account is connected to Apple.

last_namestring

Last name of the user.

avatar_urlstring

URL of the user avatar. null if none is set.

first_namestring

First name of the user.

googleappsboolean

Whether the account is connected to Google.

facebookappsboolean

Whether the account is connected to Facebook.

is_logged_inboolean

Whether the user is logged in.

microsoftappsboolean

Whether the account is connected to Microsoft.

primary_emailstring

Primary email address of the user.

document_countinteger

Number of documents the user has.

is_scim_managedboolean

Whether the account is managed through SCIM.

password_changedinteger

Unix timestamp of the last password change.

has_atticus_accessboolean

Whether the user has access to Atticus.

issue_notificationsobject[]

Account notifications that need attention.

registration_sourcestring

Source the account was registered from. null if unknown.

signer_phone_inviteobject

Phone invite details of the user. null if none.

modified_primary_emailstring

Primary email address after the last change. The same as primary_email if it was not changed.

monthly_document_countstring

Number of documents the user has created this month, as a string.

lifetime_document_countinteger

Number of documents the user has created since the account was opened.

cloud_export_account_detailsobject

Details of the connected cloud export account. null if none is connected.

Changes

No recorded changes to this operation across all 1 revision of this API.