---
title: "Return CalDAV and CardDAV connection information"
method: GET
path: "/DAV/get_calendar_contacts_config"
tags: ["DAV", "Calendar and Contacts (DAV)"]
---

# Return CalDAV and CardDAV connection information

`GET /DAV/get_calendar_contacts_config`

This function returns the connection information to set up the CalDAV and CardDAV clients.

## Query parameters

- `user` union
  - string, username — A cPanel account.
  - string, email — A valid email account.

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object
      - `activesync` object — Configuration details for ActiveSync.
        - `enabled` 1 | 0 — Whether the server has ActiveSync enabled. * `1` — Enabled. * `0` — **Not** enabled.
        - `port` integer — The port number the system uses for secure ActiveSync connections.
        - `server` string, domain — The fully qualified domain name to connect to.
        - `user` string — The cPanel user or email account user to whom the returned connection information pertains. If you do **not** specify the `user` parameter, this function returns the authenticated cPanel user.
      - `no_ssl` object — A list of non-SSL connection configurations.
        - `calendars` object[] — An array of objects containing the user's calendars.
          - `description` string — The description of the calendar.
          - `name` string — The name of the calendar.
          - `path` string — The relative URL path to the calendar.
          - `url` string, url — The absolute URL to the calendar.
        - `contacts` object[] — An array of objects containing the user's address books.
          - `description` string — The description of the address book.
          - `name` string — The name of the address book.
          - `path` string — The relative URL to the address book.
          - `url` string, url — The absolute URL to the address book.
        - `free_busy` string, url — The absolute URL path and HTTP port to the user's CalDAV `free-busy-query` connection. **Note:** This information is useful for clients that support Autodiscovery.
        - `full_server` string, url — The absolute URL path and HTTP port to the user's CalDAV and CardDAV connection information. **Note:** This information is useful for clients that do **not** support Autodiscovery.
        - `port` integer — The port number that the system uses for non-SSL connections.
        - `server` string, url — The short server connection string that includes a domain name and a port that uses the HTTP protocol.
      - `ssl` object — A list of SSL connection configurations.
        - `calendars` object[] — An array of objects containing the user's calendars.
          - `description` string — The description of the calendar.
          - `name` string — The name of the calendar.
          - `path` string — The relative URL path to the calendar.
          - `url` string, url — The absolute URL to the calendar.
        - `contacts` object[] — An array of objects containing the user's address books.
          - `description` string — The description of the address book.
          - `name` string — The name of the address book.
          - `path` string — The relative URL to the address book.
          - `url` string, url — The absolute URL to the address book.
        - `free_busy` string, url — The absolute URL path and HTTPS port to the user's CalDAV `free-busy-query` connection. **Note:** This information is useful for clients that support Autodiscovery.
        - `full_server` string, url — The absolute URL path and HTTPS port to the user's CalDAV and CardDAV connection information. **Note:** This information is useful for clients that do **not** support Autodiscovery.
        - `is_self_signed` 1 | 0 — Whether the server uses a self-signed certificate. * `1` — Self-signed. * `0` — **Not** self-signed.
        - `port` integer — The port number that the system uses for SSL connections.
        - `server` string, url — The short server connection string that includes a domain name and a port that uses the HTTPS protocol. **Note:** This value is useful for clients that support Autodiscovery.
      - `user` string — The cPanel user or email account user to whom the returned connection information pertains. If you do **not** specify the `user` parameter, this function returns the authenticated cPanel user.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
    - `status` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/revisions/632e2f8e6d04/schema)