Get Account List

Use this API to query NineData organization accounts with pagination. Filter the result by account ID, account name, or login name.

Request URL: /openapi/v1/account/list

Request Method: GET

Request Parameters

Parameter	Type	Required	Description	Example
accountId	String	No	Account ID.	170**********159
accountName	String	No	Account name.	NineData
loginName	String	No	Account login name.	138********
status	String	No	Account status: normal, freeze, or inviting. Omit this parameter to return all statuses.	normal
current	Integer	No	Current page number, starting from 1, default is 1.	1
pageSize	Integer	No	Page size, default is 10.	10

Response Parameters

Parameter	Type	Description	Example
success	Bool	Whether the interface call is successful. Return values: true, false.	true
requestId	String	Request ID.	Ww2k2GVI-DJGGvSDnEJKv3PFdHIp6ETC
data	Array	Account list, including account information and role information. Account information: accountId: Account ID. accountName: Account name. loginName: Account login name. status: Account status. Return values: normal: Normal. freeze: Frozen. inviting: Inviting accountType: Account type. Return values: general: General account. sso: SSO single sign-on account. mobile: Mobile phone number. mail: Email. lastLoginTime: Last login time. roleList: Role list Role information: roleId: Role ID. name: Role name. type: Role type. Return values: system: System administrator. custom: Regular role.	{ "accountId": "170**********159", "accountName": "NineData", "loginName": "138********", "status": "normal", "accountType": "general", "mobile": "138********", "mail": "g**@9z.cloud", "lastLoginTime": "2025-08-04 03:41:39Z", "roleList": [{ "roleId": "635", "name": "System Administrator", "type": "system" }
current	Integer	Current page number.	1
pageSize	Integer	Size of each page.	10
total	Integer	Total number of accounts.	4

Successful Invocation Example

{
    "success": true,
    "requestId": "Rv6t8FZX-JPNMqTHnKPQd1DHdRLw4DTQ",
    "data": [{
        "accountId": "170**********159",
        "accountName": "NineData",
        "loginName": "138********",
        "status": "normal",
        "accountType": "general",
        "mobile": "138********",
        "mail": "g**@9z.cloud",
        "lastLoginTime": "2025-08-04 03:41:39Z",
        "roleList": [{
            "roleId": "635",
            "name": "System Administrator",
            "type": "system"
        }]
    }],
    "current": 1,
    "pageSize": 10,
    "total": 1
}

Result

A successful response returns matching accounts and their assigned roles. Use accountId when you query audit logs, SQL execution logs, or permission-related OpenAPI resources.