Skip to navigation
Management APIAccounts

Get an Account

View as Markdown

Returns the account identified by id in the path. Requires a service credential with the read:accounts scope.

The response has the same shape as create and update and is read from the system of record, so a value written by Update an Account is visible on the next read. Contacts are not included.

Authentication

AuthorizationBearer
This authentication type can be used to directly call the service.
OR
X-API-KEYstring
This authentication type is supported by using the provided API key for the merchant account.

Path parameters

idlongRequired>=1
Identifier of the account to fetch.

Response

OK
accountIdlong
Identifier of the account.
createdAtstringformat: "date-time"
When the account was created. Stored to the minute.
emailstring
Primary email for the account.
namestring
Name of the account.
$schemastringOptionalRead-onlyformat: "uri"
A URL to the JSON Schema for this object.
contactobjectOptional
The account's first contact. Returned by create only.
einstringOptional
Employer Identification Number, when one was supplied.
phonestringOptional
Account phone number, when one was supplied.
stateIncorporatedstringOptional
State of incorporation, when one was supplied.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error