Accounts: GetAccountInformation

Returns details about a company account.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The id of the account.

Responses

CodeDescriptionReference
200

Account information successfully retrieved

AccountSummary
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Accounts::GetAccountInformation

Definitions

AccountSummary

Contains details about a company account.

companyIdinteger

The id of the company.

namestring

The name of the company.

companyVersionstring

The version of Rooms that the company uses. Read only. Possible values are:

  • v5: Rooms Version 5.
  • v6: Rooms Version 6.

docuSignAccountGuidstring

The globally-unique identifier (GUID) for the DocuSign Rooms account.

defaultFieldSetIdstring

The id of the company's default field set. A field set is a set of data fields and the information about those data fields that the system uses to configure rooms. It corresponds to the Admin > Company > Room Details area in the console.

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

}} />