---
title: "GET /api/dyn_ade"
method: GET
path: "/api/dyn_ade"
tags: ["Dynamic Links"]
---

# GET /api/dyn_ade

`GET /api/dyn_ade`

## Request

- Base URL: `https://addcal.co`
- URL: `https://addcal.co/api/dyn_ade`
- Auth: none required

## Query parameters

- `client` string, required: AddEvent compatibility alias for uid. Your Dynamic Link Key identifier.
- `service` string, required: Calendar service to redirect to. AddEvent values (outlookcom, stream) are automatically mapped. Accepted: google, apple, outlook, outlook_web, office365, yahoo, ics, manual.
- `title` string, required: Event title. Max 255 characters.
- `start` string, required: Start date/time in ISO 8601 format.
- `end` string: End date/time in ISO 8601 format. Defaults to 1 hour after start if omitted.
- `duration` integer: Duration in minutes. Takes precedence over end.
- `timezone` string: IANA timezone. Required for timed events.
- `all_day_event` boolean: Set to true for all-day events.
- `description` string: Event description. Max 2000 characters.
- `location` string: Physical address or virtual meeting URL. Max 255 characters.
- `alarm` integer: Reminder in minutes before the event.
- `recurring` string: RFC 5545 recurrence rule (RRULE).
- `transp` string: Busy status: OPAQUE (busy) or TRANSPARENT (free). Defaults to OPAQUE.

## Request body

- object
  - `uid` string, required
  - `title` string, required: Must not be greater than 255 characters.
  - `start` string, required: Must be a valid date.
  - `end` string, nullable: Must be a valid date. Must be a date after or equal to <code>start</code>.
  - `duration` integer, nullable: Must be at least 1.
  - `all_day_event` string, nullable
  - `timezone` string, required: Must be a valid time zone, such as <code>Africa/Accra</code>.
  - `description` string, nullable: Must not be greater than 2000 characters.
  - `location` string, nullable: Must not be greater than 255 characters.
  - `alarm` integer, nullable: Must be at least 0.
  - `recurring` string, nullable
  - `transp` 'TRANSPARENT' | 'OPAQUE', nullable
  - `service` string, nullable

## Other responses

- `302`: Redirects the user to the chosen calendar service with the event pre-filled.
- `403`: Team is not on the Business plan.
- `404`
- `422`: When validation fails (e.g. missing required params or unrecognised service).

---

[API](https://skmtc.dev/addcal/apis/addcal-api-documentation.md) · [All operations](https://skmtc.dev/addcal/apis/addcal-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/addcal/apis/addcal-api-documentation/revisions/addd0607e492?raw)