Accounts

Retrieve an account

Changed on

Retrieves the details of an existing account.

get/v3/accounts/{id}

Request

  • Base URL
    https://api.cryptlex.com
  • URL
    https://api.cryptlex.com/v3/accounts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier for the account.

Query parameters

includeIncludeAccountProperties[]

Response

OK

idstring required
createdAtstring date-time required
updatedAtstring date-time required
companystring required
emailstring required
status'active' | 'inactive' required
adminPortalDomainstring required
customerPortalDomainstring required
resellerPortalDomainstring required
websitestring nullable
logoUrlstring required
faviconUrlstring required
googleClientIdstring required
trialExpiresAtstring date-time required
companyIdstring required
accountAliasstring required
regionstring required
paymentMethodstring required
pspstring required
totalTrialExtensionsinteger required
teamMemberTwoFactorRequiredFromstring date-time nullable
userTwoFactorRequiredFromstring date-time nullable
twoFactorGracePeriodinteger required

Changes

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • info

      added the required property / to the response with the status