Retrieves the account information for the specified account.

Response The canUpgrade property contains is a Boolean that indicates whether the account can be upgraded through the API.

Request

HTTP request

GET /v2/accounts/{accountId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

Optional Query Parameters
include_account_settingsstring

When set to true, includes the account settings for the account in the response.

Responses

CodeDescriptionReference
200

Successful response.

Accounts
400

Error encountered.

errorDetails

SDK Method

Accounts::getAccountInformation

Definitions

errorDetails
Accounts

Examples

Generic JSON Response
Generic XML Response