List cPanel account's calendar users

This function lists all calendar users on the cPanel account.

Note:

You must install the Calendar and Contacts Server cPanel plugin to access this API function.

SecurityBasicAuth

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/CCS/list_users

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  CCS \
  list_users

Response samples

application/json

{"apiversion": 3,
"func": "list_users",
"module": "CCS",
"result": {"data": {"user1@example.com": "0882362A-0B98-11E8-BAF5-D988266709C1",
"user2@example.com": "96F1EB2F-A501-11EA-A3EF-A553B2E4FFA8",
"user3@example.com": "195C8A51-E1B3-11E6-8715-F54FA4E00DDD",
"user4@example.com": "028F4AB1-0F1A-11E7-AEC7-E08FECEC8036"
},
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}