List sub-users

Description

Get a list of all API sub-users you have. The method works with pagination.


 Parameters

Name Data Type Status Description
auth-id Integer Required Authentication parameter
auth-password String Required Authentication parameter
page Integer Required The sub-users listed on the chosen page
rows-per-page Integer Required Results per page. Can be 10, 20, 30, 50 or 100

Return: List with the information for the found users


Possible errors (example)

When the authentication of the API user is not correct, the API request will fail with the following status and statusDescription:

{"status":"Failed","statusDescription": "Invalid authentication, incorrect user ID or password."}

If there is a missing or incorrect value added for "page", the following status will be returned:

{"status":"Failed","statusDescription": "Missing or invalid required parameter 'page'."}

If there is a missing or incorrect value added for "rows-per-page", the following status will be returned:

{"status":"Failed","statusDescription": "Missing required parameter 'rows-per-page''}

Note: These are example errors in JSON format, and these are not the only errors that can be displayed.


Example

URL JSON: https://api.cloudns.net/sub-users/list-sub-users.json
POST/GET: auth-id=0&auth-password=password&page=1&rows-per-page=10

URL XML: https://api.cloudns.net/sub-users/list-sub-users.xml
POST/GET: auth-id=0&auth-password=password&page=1&rows-per-page=10


Last modified: 2025-05-15
Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more