Prospero API

Views

Endpoint:https://api.prosperoapp.com

Views allow you to filter your Events, create custom calendar links, and sync with third-party calendars.

List Views

GET

https://api.prosperoapp.com

/views

Returns a list of all Views in your Organization.

List Views › Responses

A list of Views.

viewsobject[]

Create a View

POST

https://api.prosperoapp.com

/views

Creates a View based on the provided fields.

You can optionally configure the sync property to immediately sync this View to third-party calendars (Google Calendar and/or Outlook Calendar) for the creating User.

Create a View › Request Body

orgIdstring · uuid
The id of the Organization that owns this View.
namestring
The name of the View.
timezonestring
The timezone for this View, in IANA timezone database format.
filtersobject
Filters that determine which Events are included in the View.
publicboolean
Whether this View is publicly accessible via a shareable link.
slugstring
The URL slug for this View. If not provided, a random string of six characters will be generated. Used to create the public link with the pattern https://view.prosperoapp.com/{orgNamespace}/{slug}.
syncobject
Third-party calendar sync settings for the creating User.
defaultsobject
Default display and format settings for a View.
visibilityobject
Determines which entities and fields are visible in view links. Fields set to false are scrubbed from public endpoints and their data never reached client devices.
announcementsstring · html
HTML content to display as announcements at the top of the View link. Supports basic HTML tags and formatting.

Create a View › Responses

The newly created View.

viewobject

Retrieve a View

GET

https://api.prosperoapp.com

/views/{viewId}

Retrieves the View with the given id.

Retrieve a View › path Parameters

viewIdstring · uuid · required
The id of the View.

Retrieve a View › Responses

The requested View.

viewobject

Delete a View

DELETE

https://api.prosperoapp.com

/views/{viewId}

Deletes the specified View.

Delete a View › path Parameters

viewIdstring · uuid · required
The id of the View.

Delete a View › Responses

The View was successfully deleted.

No data returned

Update a View

PATCH

https://api.prosperoapp.com

/views/{viewId}

Updates the specified View by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a View's id.

Update a View › path Parameters

viewIdstring · uuid · required
The id of the View.

Update a View › Request Body

namestring
The name of the View.
timezonestring
The timezone for this View, in IANA timezone database format.
filtersobject
Filters that determine which Events are included in the View.
publicboolean
Whether this View is publicly accessible via a shareable link.
slugstring
The URL slug for this View.
defaultsobject
Does not support partial updates. Always pass the full defaults object when updating any field within the object.
visibilityobject
Partial update to visibility settings.
announcementsstring · html
HTML content to display as announcements at the top of the View link. Supports basic HTML tags and formatting.

Update a View › Responses

The updated View.

viewobject

Subscriptions Projects

Prospero API

Views

Endpoint:https://api.prosperoapp.com

Views allow you to filter your Events, create custom calendar links, and sync with third-party calendars.

List Views

GET

https://api.prosperoapp.com

/views

Returns a list of all Views in your Organization.

List Views › Responses

A list of Views.

viewsobject[]

Create a View

POST

https://api.prosperoapp.com

/views

Creates a View based on the provided fields.

You can optionally configure the sync property to immediately sync this View to third-party calendars (Google Calendar and/or Outlook Calendar) for the creating User.

Create a View › Request Body

orgIdstring · uuid
The id of the Organization that owns this View.
namestring
The name of the View.
timezonestring
The timezone for this View, in IANA timezone database format.
filtersobject
Filters that determine which Events are included in the View.
publicboolean
Whether this View is publicly accessible via a shareable link.
slugstring
The URL slug for this View. If not provided, a random string of six characters will be generated. Used to create the public link with the pattern https://view.prosperoapp.com/{orgNamespace}/{slug}.
syncobject
Third-party calendar sync settings for the creating User.
defaultsobject
Default display and format settings for a View.
visibilityobject
Determines which entities and fields are visible in view links. Fields set to false are scrubbed from public endpoints and their data never reached client devices.
announcementsstring · html
HTML content to display as announcements at the top of the View link. Supports basic HTML tags and formatting.

Create a View › Responses

The newly created View.

viewobject

Retrieve a View

GET

https://api.prosperoapp.com

/views/{viewId}

Retrieves the View with the given id.

Retrieve a View › path Parameters

viewIdstring · uuid · required
The id of the View.

Retrieve a View › Responses

The requested View.

viewobject

Delete a View

DELETE

https://api.prosperoapp.com

/views/{viewId}

Deletes the specified View.

Delete a View › path Parameters

viewIdstring · uuid · required
The id of the View.

Delete a View › Responses

The View was successfully deleted.

No data returned

Update a View

PATCH

https://api.prosperoapp.com

/views/{viewId}

Updates the specified View by setting the values of the fields passed. Any fields not provided will be left unchanged. By design, you cannot change a View's id.

Update a View › path Parameters

viewIdstring · uuid · required
The id of the View.

Update a View › Request Body

namestring
The name of the View.
timezonestring
The timezone for this View, in IANA timezone database format.
filtersobject
Filters that determine which Events are included in the View.
publicboolean
Whether this View is publicly accessible via a shareable link.
slugstring
The URL slug for this View.
defaultsobject
Does not support partial updates. Always pass the full defaults object when updating any field within the object.
visibilityobject
Partial update to visibility settings.
announcementsstring · html
HTML content to display as announcements at the top of the View link. Supports basic HTML tags and formatting.

Update a View › Responses

The updated View.

viewobject

Subscriptions Projects