Help Center/ Organizations/ API Reference/ APIs/ Managing Accounts/ Querying CloseAccount Requests in Specified State

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

View PDF

Querying CloseAccount Requests in Specified State

Function

This API is used to query the CloseAccount requests in the specified state for an organization. This API can be called only from the organization's management account or a delegated administrator account.

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/close-account-status

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
states	No	Array of strings	List of one or more states that you want to include in the response. If this parameter is not present, all requests are included in the response.

Request Parameters

**Table 2** 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 3** Response body parameters
Parameter	Type	Description
close_account_statuses	Array of CloseAccountStatusDto objects	List of objects with details about the requests.

**Table 4** CloseAccountStatusDto
Parameter	Type	Description
account_id	String	Unique ID of an account.
created_at	String	Date and time when the CloseAccount request was made.
updated_at	String	Date and time when the status of CloseAccount request was updated.
organization_id	String	Unique ID of an organization.
state	String	Status of the CloseAccount request. pending_closure indicates that the account is being closed. suspended indicates that the account has been closed.
failure_reason	String	Reason for a request failure.

Example Requests

Querying CloseAccount requests in the specified state

GET https://{endpoint}/v1/organizations/close-account-status

Example Responses

Status code: 200

Successful

{
  "close_account_statuses" : [ {
    "account_id" : "0a6d25d23900d45c0faac010e0fb4de0",
    "updated_at" : "2022-08-24T06:41:15Z",
    "created_at" : "2022-08-24T06:41:15Z",
    "organization_id" : "o-awjp43m7bz3b8jgy5v61jrfwakt3og8w",
    "state" : "pending_closure",
    "failure_reason" : "string"
  } ]
}