Get account list

Gets the list of all accounts in a CelerData Cloud BYOC organization.

NOTE

This operation requires the Organization Management privilege.

Request

Basic information
HTTP URL	https://cloud-api.celerdata.com/api/1.0/accounts
HTTP method	GET
Frequency	600/minute

Header parameters

Parameter	Example value	Required	Type	Description
Authorization	Bearer OGQ5MDA4MZGTNJMWNS0ZY2Y2LWFJNZYTOTBINMZIYTGZZDUY	Yes	String	The access token used to access the CelerData Cloud BYOC API. Format: Bearer <access_token>.

See Obtain access token.

Response

Sample response

{
    "code": 20000,
    "data": [
        {
            "account_id": "lbyx0bt7a",
            "account_name": "A1",
            "email": "a@a.com",
            "state": "IN_USE",
            "is_root_account": true,
            "create_at": 1675858169913
        }
    ]
}

Response elements

Parameter	Example value	Type	Description
code	20000	Integer	The error code. If the error code returned is 20000, the request succeeded. If any other error code is returned, the request failed.
data	-	Object	The result of the API call. The data object may not be returned for some API actions. It returns the list of account information.
data.account_id	lbyx0bt7a	String	The ID of the account.
data.account_name	-	String	The name of the account.
data.email	-	String	The email address of the account.
data.state	IN_USE	String	The state of the account. Valid values: IN_USE: The account is in use. NO_ACCOUNT_NAME: The account is not activated via the confirmation email.
data.is_root_account	true	Boolean	Whether the account is the root account.
data.create_at	-	Timestamp	The timestamp when the account was created.
message	-	String	The error message. This element is returned only when the code returned is not 20000. NOTICE Do not conclude whether a request succeeded or failed based on the return value of message.