Listing Accounts_Account Management_API_API Reference

Function

This API is used to list all accounts assigned to a user.

URI

GET /v1/assigned-accounts

**Table 1** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on a page Minimum value: 1 Maximum value: 2000 Default value: 200
marker	No	String	Pagination marker, which is used only for paging interfaces Minimum length: 4 Maximum length: 400

Request Parameters

**Table 2** Parameters in the request header
Parameter	Mandatory	Type	Description
access-token	Yes	String	Access token issued by the creating token API Maximum length: 4096

Response Parameters

Status code: 200

**Table 3** Parameters in the response body
Parameter	Type	Description
account_list	Array of objects	Listed accounts
page_info	Object	Pagination information

**Table 4** account_list
Parameter	Type	Description
account_id	String	Globally unique ID of the account assigned to a user
account_name	String	Name of the account assigned to a user
email_address	String	Email address of the account assigned to a user Minimum length: 1 Maximum length: 254

**Table 5** page_info
Parameter	Type	Description
next_marker	String	If present, it indicates that the available output is more than the output contained in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this operation until the next_marker response returns null.
current_count	Integer	Number of records returned on this page

Example Request

Listing all accounts assigned to a user

GET https://{hostname}/v1/assigned-accounts

Example Response

Status code: 200

Successful

{
  "account_list" : [ {
    "account_id" : "5146d03d8aaaaaaaaaaaabbae60620a5",
    "account_name" : "example-account-name",
    "email_address" : "email@example.com"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.

Listing Accounts