Help Center/ Organizations/ API Reference/ APIs/ Managing Accounts/ Getting Account Information

Updated on 2024-10-21 GMT+08:00

View PDF

Getting Account Information

Function

This API is used to get the information about the specified account. It can be called only from the organization's management account or from a member account that is a delegated administrator for a cloud service.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET https://{endpoint}/v1/organizations/accounts/{account_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
account_id	Yes	String	Unique ID of an account.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
with_register_contact_info	No	Boolean	Whether to return email addresses and mobile numbers associated with the account. If True is returned, the maximum number of entries allowed is 200.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
account	AccountDto object	Information about the member accounts in an organization.

**Table 5** AccountDto
Parameter	Type	Description
id	String	Unique ID of an account.
urn	String	Uniform resource name of the account.
join_method	String	How an account joined an organization.
status	String	Account status. It can be active, suspended, or pending_closure.
joined_at	String	Date when an account joined an organization.
name	String	Account name.
mobile_phone	String	Mobile number.
intl_number_prefix	String	Prefix of a mobile number.
email	String	Email address associated with the account.
description	String	Description.

Example Requests

Getting Account Information

GET https://{endpoint}/v1/organizations/accounts/{account_id}

Example Responses

Status code: 200

Successful.

{
  "account" : {
    "id" : "05261f923e80d3890f33c0056e9b3f80",
    "urn" : "organizations::0a6d25d23900d45c0faac010e0fb4de0:account:o-fhkmi6mek7wlqdp6nideqhb47qwtjdsv/05261f923e80d3890f33c0056e9b3f80",
    "join_method" : "invited",
    "status" : "active",
    "joined_at" : "2022-08-24T06:41:15Z",
    "name" : "paas_iam_573331",
    "description" : "string",
    "mobile_phone" : "null,",
    "intl_number_prefix" : "null,",
    "email" : null
  }
}