v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB

DAV

Calendar and Contacts (DAV)

List CalDAV and CardDAV users

This function lists the users that are available for use with CalDAV and CardDAV

get/CPDAVD/list_users

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "list_users",
  "module": "CPDAVD",
  "result": {
    "data": [
      {
        "someone@example.com": {
          "addressbook": {
            "description": "Default Address Book automatically created for your account.",
            "displayname": "cPanel CardDAV Address Book",
            "protected": 1,
            "type": "VADDRESSBOOK"
          },
          "calendar": {
            "calendar-color": "#ff6c2c",
            "description": "Default Calendar automatically created for your account.",
            "displayname": "cPanel CalDAV Calendar",
            "protected": 1,
            "type": "VCALENDAR"
          }
        }
      }
    ],
    "status": 1
  }
}