Retrieve Calendar Events

get

https://{APP_DOMAIN}/api/3.2/calendar-event

Returns a paginated list of calendar events used to schedule Updates and Dedicated Offers. When filter_date is provided, returns events within a 4-month window (2 months before and after the date).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

integer

Filter by event ID

name

string

Filter by event name

description

string

Filter by description

publication_id

integer

Filter by publication ID

calendar_event_category_id

integer

Filter by calendar event category ID

start_date_time

string

Filter by start date. Supports operators: >, >=, <, <=

end_date_time

string

Filter by end date. Supports operators: >, >=, <, <=

filter_date

string

Center date for a 4-month window (2 months before and after). Defaults to current date when not provided.

created_at

string

Filter by creation date. Supports operators: >, >=, <, <=

updated_at

string

Filter by last updated date. Supports operators: >, >=, <, <=

status

array of strings

Filter by message status. placeholder: an email Update with no author or article; assigned: an author but no article; needs_content: a lift letter or SMS with no content; needs_ads: content is attached but an ad slot has no ad assigned; the rest are states of the built message. Ready and incomplete depend on resolved defaults, so read them from the event's message.

status

missing_content

boolean

Only events whose message still needs its article, lift letter, or SMS text (true), or only those that have it (false). Before their message is saved, SMS events and email Updates count as missing, and email Dedicated Offers do unless they already name a lift letter.

has_message

boolean

Only events with (true) or without (false) a built message

content_due_before

string

Only events whose content is due on or before this wall-clock date-time

assigned_user_id

integer

Only events assigned to this user directly or through one of their groups

author_id

integer

Only events whose data names this author (the publication author ID)

resource_id

integer

Only events whose message uses this article or lift letter in any variant

with_message_state

boolean

Add message_state to each event: status (placeholder, assigned, needs_content, needs_ads, in_progress, or a built state: pending_approval, approved, denied, cancelled, sent), overdue, out_of_sync, needs_reschedule, and issues (what someone still has to do, one line each: the missing list saved the last time the event's message was checked, or else one denial, rebuild, or reschedule note), and missing_count (how many of the issues are missing items; 0 when the only issue is a note). Built from stored state; in_progress means nothing stored blocks the message, and whether it is ready comes from get_calendar_event_message.

columns[]

array of strings

The field names to be included in the JSON response. You can have multiple columns[] query params included in the request URL (e.g. columns[]=id&columns[]=name).

columns[]

page

integer

The page to return.

per_page

integer

The total results to return per page.

sort

string

The field to sort the request by. column_name|asc OR desc

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

200The retrieved calendar events