Prospero API

Schemas

APIError

statusinteger
The HTTP status code of the error.
errorstring
Human-readable error message. Unless it would result in a security vulnerability, the error message attempts to provide a specific explanation of the error.

Address

addressLineOnestring
addressLineTwostring
citystring
statestring
countrystring
postalCodestring

Column

idinteger
The order index of the column (a simple number, not a UUID).
labelstring
The column name, like "Start" or "Tags".
checkedboolean
Whether this column is shown.

DayFormat

splitByinteger · enum
The entity type to split the day layout by.

Value Name
0 NONE
1 PROJECT
2 LOCATION
3 PEOPLE
4 GROUP
5 ITEM
6 TAG
7 CONSUMABLE
Enum values:
0
1
2
3
4
5
6
7
splitBySelectedIdsobject[]
The selected entities to split by, in order.
autoSplitDaySplitByboolean
If enabled, automatically split into columns based on the chosen splitBy entity, overriding manually specified splitBySelectedIds.
showProjectAbbreviationboolean
Whether to show Project abbreviations at the end of Event titles.
showEndTimeboolean
Whether to show Event end times on the calendar (start times are always displayed).
showPeopleboolean
Whether to show People attached to Events on the calendar.
showNotesboolean
Whether to show the details of Events on the calendar.
zoominteger · min: 20 · max: 160
Zoom level for the day layout. Must be a multiple of 20 between 20 and 160.
colorByinteger · enum
The entity type to use for coloring Events on the calendar.

Value Name
0 PROJECT
1 LOCATION
2 TAG
3 ITEMSET
4 CONSUMABLE
Enum values:
0
1
2
3
4

FeatEventFilters

projectstring[]
The ids of Projects to include. If empty, all Projects are included.
rolestring[]
The ids of Roles to include. If empty, all Roles are included.
roleGroupstring[]
The ids of RoleGroups to include. If empty, all RoleGroups are included.
locationstring[]
The ids of Locations to include. If empty, all Locations are included.
peoplestring[]
The ids of People to include. If empty, all People are included.
groupstring[]
The ids of Groups and Collections to include. If empty, all Groups and Collections are included.
itemstring[]
The ids of Items to include. If empty, all Items are included.
consumablestring[]
The ids of Consumables to include. If empty, all Consumables are included.
tagstring[]
The ids of Tags to include. If empty, all Tags are included.

FeaturedEventList

orderIndexinteger
The order of this featured list amongst all featured lists.
labelstring
The name of this featured list.
filtersobject
Filters that determine which Events are included in the featured list.
excludeboolean
Whether to exclude Events matching the featured list filters from the main list.

Format

monthobject
Format configuration for month layout.
weekobject
Format configuration for week layout.
dayobject
Format configuration for day layout.
listobject
Format configuration for list layout.

Id

string · uuid

The globally unique identifier of this entity. Prospero uses v1 UUIDs.

ISO8601DateTime

string · date-time

An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.

ImageId

string · uuid

The UUID of an image stored in Cloudflare Images.

ListBy

string · enum

Enum values:

day

project

location

people

item

tag

consumable

The entity type to group list layout by.

ListFormat

featuredListsobject[]
Featured Event lists to display above the main list.
mainListTitlestring
The title of the main list. Unused if there are no featured lists.
listBystring · enum
The entity type to group list layout by.
Enum values:
day
project
location
people
item
tag
consumable
displayDividersboolean
Whether to display dividers between columns.
columnsobject[]
The columns to display in list layout.
titleColumnOptionsobject
Display options for the title column.

MonthFormat

weekStartsOninteger · enum
The day of the week that starts the week.

Value Name
0 SUNDAY
1 MONDAY
Enum values:
0
1
showProjectAbbreviationboolean
Whether to show Project abbreviations at the end of Event titles.
colorByinteger · enum
The entity type to use for coloring Events on the calendar.

Value Name
0 PROJECT
1 LOCATION
2 TAG
3 ITEMSET
4 CONSUMABLE
Enum values:
0
1
2
3
4

NotificationTrigger

tostring[]
The email addresses to send the notification to.
bodystring
The message from the admin to include in the body of the email. Note that the majority of the message will be automatically generated.

PriceMap

integer

Price with two significant digits (i.e., 49.99 is $49.99 or €49.99 or £49.99, etc.).

PortalAuthentication

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object · requires: password

Properties for Variant 1:

Public authentication (no password required)

methodinteger · enum · required
The authentication method for the Portal - must be 0 to indicate the Portal does not require authentication.

Value Name Description
0 PUBLIC No authentication required
1 PASSWORD Password authentication required
Enum values:
0
1

ViewDefaults

layoutinteger · enum
The layout of the calendar.

Value Name
0 LIST
1 DAY
2 WEEK
3 MONTH
Enum values:
0
1
2
3
startDate
The date to load during initial display.
windowDaysinteger
The number of days to display in list layout. Has no effect on other calendar layouts.
formatobject
Format configurations for all calendar layouts.

ViewFilters

projectsstring[]
The ids of Projects to include. If empty, all Projects are included.
rolesstring[]
The ids of Roles to include. If empty, all Roles are included.
roleGroupsstring[]
The ids of RoleGroups to include. If empty, all RoleGroups are included.
locationsstring[]
The ids of Locations to include. If empty, all Locations are included.
statusesinteger[]
The Event statuses to include. If empty, all statuses are included.
Enum values:
0
1
2
3
4
5
peoplestring[]
The ids of People to include. If empty, all People are included.
groupsstring[]
The ids of Groups and Collections to include. If empty, all Groups and Collections are included.
itemsstring[]
The ids of Items to include. If empty, all Items are included.
consumablesstring[]
The ids of Consumables to include. If empty, all Consumables are included.
tagsstring[]
The ids of Tags to include. If empty, all Tags are included.

ViewVisibility

projectsboolean
Whether Projects are visible.
rolesboolean
Whether Roles are visible.
roleGroupsboolean
Whether RoleGroups are visible.
locationsboolean
Whether Locations are visible.
peopleboolean
Whether People are visible.
groupsboolean
Whether Groups (people-based) are visible.
collectionsboolean
Whether Collections (item-based Groups) are visible.
itemsboolean
Whether Items are visible.
consumablesboolean
Whether Consumables are visible.
tagsboolean
Whether Tags are visible.
filesboolean
Whether Files are visible.
flagboolean
Whether Event flags are visible.
detailsboolean
Whether Event details are visible.

WeekFormat

weekStartsOninteger · enum
The day of the week that starts the week.

Value Name
0 SUNDAY
1 MONDAY
Enum values:
0
1
showProjectAbbreviationboolean
Whether to show Project abbreviations at the end of Event titles.
showEndTimeboolean
Whether to show Event end times on the calendar (start times are always displayed).
showPeopleboolean
Whether to show People attached to Events on the calendar.
showNotesboolean
Whether to show the details of Events on the calendar.
zoominteger · min: 20 · max: 160
Zoom level for the week layout. Must be a multiple of 20 between 20 and 160.
colorByinteger · enum
The entity type to use for coloring Events on the calendar.

Value Name
0 PROJECT
1 LOCATION
2 TAG
3 ITEMSET
4 CONSUMABLE
Enum values:
0
1
2
3
4

TagAllowOn

eventsboolean
Whether this Tag can be applied to Events.
itemSetsboolean
Whether this Tag can be applied to ItemSets.

CustomFields

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = string
	type = number
	type = boolean

Properties for Variant 1:

string

DayAvailability

startstring · required
Start time in ISO 8601 time format, without seconds.
endstring · required
End time in ISO 8601 time format, without seconds.

BookingModuleRequiredField

descriptionstring
Optional helper text explaining this field.

ContactCustomField

idstring · uuid · required
The globally unique identifier of this custom field.
typeinteger · enum · required
Field type for custom fields in the contact portion of the booking form of a BookingModule.

Value Name
0 TEXT_SINGLE
1 TEXT_MULTI
2 NUMBER
3 EMAIL
4 PHONE
5 CHECKMARK
Enum values:
0
1
2
3
4
5
requiredboolean · required
Whether this field is required.
namestring · required
Display name for this field.
orderIndexinteger · min: 1 · required
Display order of this field in the form.

descriptionstring
Optional helper text explaining this field.

EventCustomField

idstring · uuid · required
The globally unique identifier of this custom field.
typeinteger · enum · required
Field type for custom fields in the event portion of the booking form of a BookingModule.

Value Name
0 TEXT_SINGLE
1 TEXT_MULTI
2 NUMBER
3 EMAIL
4 PHONE
5 CHECKMARK
6 TAG
7 PROJECT
8 ITEM
9 CONSUMABLE
Enum values:
0
1
2
3
4
5
6
7
requiredboolean · required
Whether this field is required.
namestring · required
Display name for this field.
orderIndexinteger · min: 1 · required
Display order of this field in the form.

descriptionstring
Optional helper text explaining this field.

ColorBy

integer · enum

Enum values:

The entity type to use for coloring Events on the calendar.

Value	Name
0	PROJECT
1	LOCATION
2	TAG
3	ITEMSET
4	CONSUMABLE

CommentRegardingType

integer · enum

Enum values:

The type of entity a Comment is attached to.

0 = EVENT

Condition

integer · enum

Enum values:

The physical condition of an Item.

Value	Name
0	FUNCTIONAL
1	NEEDS_REPAIR
2	UNDER_REPAIR

DaySplitBy

integer · enum

Enum values:

The entity type to split the day layout by.

Value	Name
0	NONE
1	PROJECT
2	LOCATION
3	PEOPLE
4	GROUP
5	ITEM
6	TAG
7	CONSUMABLE

EventStatus

integer · enum

Enum values:

The status of an Event.

0 = TENTATIVE, 1 = CONFIRMED, 2 = CANCELED, 3 = HOLD_1, 4 = HOLD_2, 5 = HOLD_3

GroupType

integer · enum

Enum values:

The type of entities a Group contains.

Value	Name	Description
0	PEOPLE	A `Group` of `People`
1	ITEMS	A `Collection` of `Items`

Layout

integer · enum

Enum values:

The layout of the calendar.

Value	Name
0	LIST
1	DAY
2	WEEK
3	MONTH

LifecycleStatus

integer · enum

Enum values:

The lifecycle status of an Item.

Value	Name
0	IN_TRANSIT
1	OWNED
2	DISCARDED

NotificationCause

integer · enum

Enum values:

The reason this Notification was created.

0 = COMMENT_CREATED, 1 = USER_MENTIONED

Permission

integer · enum

Enum values:

The permission level for access to this part of the Prospero admin application and API.

0 = NO_ACCESS, 1 = READ, 2 = COMMENT, 3 = UPDATE, 4 = CREATE, 5 = DELETE

RoleSymbol

integer · enum

Enum values:

The symbol icon for a Role or RoleGroup.

Value	Name
0	ALIEN
1	BABY
2	DETECTIVE
3	GHOST
4	MASK_HAPPY
5	MASK_SAD
6	SKULL
7	ROBOT
8	BASEBALL_CAP
9	CHEF_HAT
10	COWBOY_HAT
11	CROWN
12	FOOTBALL_HELMET
13	GRADUATION_CAP
14	HARD_HAT
15	HANDSHAKE
16	PERSON
17	KNIFE
18	MAGIC_WAND
19	SWORD
20	TROPHY
21	BACKPACK
22	COAT_HANGER
23	DRESS
24	EYEGLASSES
25	HAIR_DRYER
26	HIGH_HEEL
27	BOOK_OPEN_TEXT
28	CAMERA
29	CLIPBOARD
30	FILM_SLATE
31	HEADSET
32	MEGAPHONE
33	OFFICE_CHAIR
34	PEN_NIB
35	STAR
36	VIDEO_CAMERA
37	BLUEPRINT
38	HAMMER
39	LADDER
40	PAINT_BRUSH
41	WRENCH
42	BEER_STEIN
43	BOWL_STEAM
44	CARROT
45	COFFEE
46	COOKIE
47	FORK_KNIFE
48	ORANGE_SLICE
49	WINE
50	EQUALIZER
51	GUITAR
52	MICROPHONE_STAGE
53	MUSIC_NOTES
54	PIANO_KEYS
55	SPEAKER_HIFI
56	BROOM
57	BUILDING
58	CAR
59	KEY
60	CALL_BELL
61	CONFETTI
62	MONEY
63	PHONE
64	SHIELD_STAR
65	TICKET
66	TRAFFIC_CONE
67	LIGHTBULB
68	PLUG
69	LAPTOP

WeekStartsOn

integer · enum

Enum values:

The day of the week that starts the week.

Value	Name
0	SUNDAY
1	MONDAY

LocationType

integer · enum

Enum values:

The type of the Location - Venue or Space

0 = VENUE, 1 = SPACE

TagSymbol

integer

The visual symbol representing this Tag.

Value	Name
0	CLIPBOARD
1	BROOM
2	CAMERA
3	CAR
4	HAMMER
5	HEADSET
6	KEY
7	LADDER
8	LAPTOP
9	LIGHTBULB
10	MONITOR
11	PLUG
12	STOOL
13	TRUCK
14	VIDEO_CAMERA
15	WRENCH
16	COFFEE
17	COOKIE
18	PEPPER
19	FLOWER
20	DROP
21	MOON
22	RAINBOW
23	SUN
24	EAR
25	EYE
26	FACE_MASK
27	PERSON
28	SMILEY
29	WHEELCHAIR
30	SWORD
31	COAT_HANGER
32	DRESS
33	CROWN
34	HIGH_HEEL
35	PANTS
36	SNEAKER
37	CHAMPAGNE
38	GRADUATION_CAP
39	CASTLE_TURRET
40	HOUSE
41	PAINT_BUCKET
42	FILM_SLATE
43	HANDS_CLAPPING
44	MAGIC_WAND
45	MASK_HAPPY
46	MASK_SAD
47	TICKET
48	MICROPHONE_STAGE
49	MUSIC_NOTES
50	SPEAKER_HIFI
51	MONEY
52	CIRCLES_THREE
53	ASTERISK
54	HEXAGON
55	CLUB
56	DIAMOND
57	HEART
58	LIGHTNING
59	SPADE
60	SPARKLE
61	STAR
62	TRIANGLE
63	CLOCK
64	FLAG
65	GLOBE
66	BOOK
67	MEGAPHONE
68	TAG
69	WARNING

ConsumableSymbol

integer

The visual symbol representing this Consumable.

Value	Symbol
0	COFFEE_BEAN
1	COOKIE
2	BEER_STEIN
3	BOWL_STEAM
4	CARROT
5	ORANGE_SLICE
6	BEER_BOTTLE
7	BOWL_FOOD
8	HAMBURGER
9	PIZZA
10	PEPPER
11	DROP
12	WINE
13	FORK_KNIFE
14	AVOCADO
15	BRANDY
16	COFFEE
17	ONIGIRI
18	SHRIMP
19	ACORN
20	BREAD
21	CHEESE
22	CHERRIES
23	COOKING_POT
24	EGG
25	FISH
26	ICE_CREAM
27	DISCO_BALL
28	CHAMPAGNE
29	CALL_BELL
30	CONFETTI
31	TICKET
32	BALLOON
33	HIGH_HEEL
34	PANTS
35	SNEAKER
36	BASEBALL_CAP
37	BAG
38	BICYCLE
39	FACE_MASK
40	BANDAIDS_FILL
41	ARMCHAIR
42	CHAIR
43	BROOM
44	POTTED_PLANT
45	BASKET
46	LADDER
47	FAN
48	LIGHTBULB
49	KNIFE
50	LIGHTNING
51	BLUEPRINT
52	HAMMER
53	PAINT_ROLLER
54	PAINT_BRUSH
55	BOOK_OPEN_TEXT
56	PEN_NIB
57	PALETTE
58	CLIPBOARD
59	PIANO_KEYS
60	SPEAKER_HIFI
61	BOOK
62	PAPERCLIP
63	PAINT_BUCKET
64	GUITAR
65	MICROPHONE_STAGE
66	GAME_CONTROLLER
67	PENCIL
68	APERTURE
69	BATTERY_FULL

BookingStatus

integer · enum

Enum values:

The status of a Booking.

Value	Name	Description
0	PENDING	The `Booking` is awaiting admin approval
1	APPROVED	The `Booking` has been approved and an `Event` has been created
2	DENIED	The `Booking` has been denied
3	CANCELED	The `Booking` has been canceled

EventCancelProcedure

integer · enum

Enum values:

Specifies how to handle the associated Event when canceling a Booking.

Value	Name	Description
0	CANCEL	Mark the `Event` as canceled
1	DELETE	Delete the `Event` entirely

PortalStatus

integer · enum

Enum values:

The publish status of the Portal.

Value	Name	Description
0	LIVE	The `Portal` is publicly accessible
1	DRAFT	The `Portal` is in draft mode and not publicly accessible

PortalAuthenticationMethod

integer · enum

Enum values:

The authentication method for the Portal.

Value	Name	Description
0	PUBLIC	No authentication required
1	PASSWORD	Password authentication required

BookingModuleEventTitles

integer · enum

Enum values:

Display option for Event titles in the BookingModule calendar.

Value	Name	Description
0	BOOKED	Show all `Event` titles as "Booked"
1	EVENT_TITLE	Show actual `Event` titles

BookingModulePendingTitles

integer · enum

Enum values:

Display option for pending Booking titles in the BookingModule calendar.

Value	Name	Description
0	REQUESTED	Show all pending `Booking` titles as "Requested"
1	BOOKING_TITLE	Show actual pending `Booking` titles

BookingModuleInventoryField

integer · enum

Enum values:

Determines what Items are bookable in the ITEM custom field.

Value	Name	Description
0	SPACE_ITEMS	Show only `Items` whose default `Location` is the selected `Space`
1	VENUE_ITEMS	Show only `Items` whose default `Location` is a `Space` within the parent `Venue` of the selected `Space`
2	ALL_ITEMS	Show all `Items` in the `Organization`

ContactCustomFieldType

integer · enum

Enum values:

Field type for custom fields in the contact portion of the booking form of a BookingModule.

Value	Name
0	TEXT_SINGLE
1	TEXT_MULTI
2	NUMBER
3	EMAIL
4	PHONE
5	CHECKMARK

EventCustomFieldType

integer · enum

Enum values:

Field type for custom fields in the event portion of the booking form of a BookingModule.

Value	Name
0	TEXT_SINGLE
1	TEXT_MULTI
2	NUMBER
3	EMAIL
4	PHONE
5	CHECKMARK
6	TAG
7	PROJECT
8	ITEM
9	CONSUMABLE

UpdateViewInput

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.

CreateCustomerInput

orgIdstring · uuid · required
The id of the Organization that owns this Customer.
namestring · required

addressobject
A physical address.
einstring
The Employer Identification Number (EIN) of the Customer, or international equivalent outside of the United States, like the Chamber of Commerce number.
vatNumberstring
The VAT registration number of the Customer (not used in the United States).
emailstring · email
The general email address of the Customer, like [email protected].
phonestring
The general phone number of the Customer.
detailsstring · html
Supports basic HTML tags and formatting.

CreateCustomerOutput

customerobject · required

ListCustomersOutput

customersobject · required

ReadCustomerOutput

customerobject · required

UpdateCustomerInput

namestring
addressobject
A physical address.
einstring
The Employer Identification Number (EIN) of the Customer, or international equivalent outside of the United States, like the Chamber of Commerce number.
vatNumberstring
The VAT registration number of the Customer (not used in the United States).
emailstring · email
The general email address of the Customer, like [email protected].
phonestring
The general phone number of the Customer.
detailsstring · html
Supports basic HTML tags and formatting.

UpdateCustomerOutput

customerobject · required

CreateContactInput

orgIdstring · uuid · required
The id of the Organization that owns this Contact.
customerIdstring · uuid · required
The id of the Customer that owns this Contact.
fullNamestring · required
The full name of the Contact.

titlestring
The job title of the Contact.
emailstring · email
The email address of the Contact.
phonestring
The phone number of the Contact.
detailsstring · html
Supports basic HTML tags and formatting.

CreateContactOutput

contactobject · required

ListContactsOutput

contactsobject · required

ReadContactOutput

contactobject · required

UpdateContactInput

fullNamestring
The full name of the Contact.
titlestring
The job title of the Contact.
emailstring · email
The email address of the Contact.
phonestring
The phone number of the Contact.
detailsstring · html
Supports basic HTML tags and formatting.

UpdateContactOutput

contactobject · required

CreateProjectInput

orgIdstring · uuid · required
The id of the Organization that owns this Project.
namestring · required
Display name of the Project.

shortNamestring
Optional abbreviated name of the Project.
colorstring · hex
A color hex code string without the leading #.
detailsstring · html
Optional details or notes about the Project. Supports basic HTML tags and formatting.
coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
keyDatesobject[]
Important dates associated with the Project.

CreateVenueInput

orgIdstring · uuid · required
The id of the Organization that owns this Venue.
typeinteger · enum · required
The type of the Location - Venue or Space

0 = VENUE, 1 = SPACE
Enum values:
0
1
namestring · required
colorstring · required
Hex color code (no #)
pricesobject · required
A map of PriceTier ids to prices.

coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
detailsstring · html
Supports basic HTML tags and formatting.
addressobject
A physical address.

UpdateVenueInput

namestring
colorstring
Hex color code (no #)
coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
pricesobject
A map of PriceTier ids to prices.
detailsstring · html
Supports basic HTML tags and formatting.
addressobject
A physical address.

CreateVenueOutput

venueobject · required

ReadVenueOutput

venueobject · required

UpdateVenueOutput

venueobject · required

CreateSpaceInput

orgIdstring · uuid · required
The id of the Organization that owns this Space.
typeinteger · enum · required
The type of the Location - Venue or Space

0 = VENUE, 1 = SPACE
Enum values:
0
1
namestring · required
colorstring · required
Hex color code (no #)
pricesobject · required
A map of PriceTier ids to prices.
venueIdstring · uuid · required
The id of the parent Venue of this Space.

coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
detailsstring · html
Supports basic HTML tags and formatting.

UpdateSpaceInput

namestring
colorstring
Hex color code (no #)
coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
pricesobject
A map of PriceTier ids to prices.
detailsstring · html
Supports basic HTML tags and formatting.

CreateSpaceOutput

spaceobject · required

ReadSpaceOutput

spaceobject · required

UpdateSpaceOutput

spaceobject · required

ListLocationsOutput

locationsarray · required

CreatePersonInput

orgIdstring · uuid · required
The id of the Organization that owns this Person.
legalFirstNamestring · required
legalLastNamestring · required

stageNamestring
The name the Person goes by when performing. This name has highest priority when rendering the Person's name throughout the platform.
nicknamestring
The name the Person goes by informally. This name is preferred over the Person's legal name when rendering the Person's name throughout the platform, though superceded by the Person's stageName.
titlestring
The job title of the Person.
pronounsstring
Common options include:
- she/her
- he/him
- they/them
- Not specified
You may also provide a custom string.
photoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
emailstring · email
phonestring
notesstring · html
Additional notes about a Person. Supports basic HTML tags and formatting.

CreatePersonOutput

personobject · required

ListPeopleOutput

peopleobject[] · required

ReadPersonOutput

personobject · required

UpdatePersonInput

legalFirstNamestring
legalLastNamestring
stageNamestring
The name the Person goes by when performing. This name has highest priority when rendering the Person's name throughout the platform.
nicknamestring
The name the Person goes by informally. This name is preferred over the Person's legal name when rendering the Person's name throughout the platform, though superceded by the Person's stageName.
titlestring
The job title of the Person.
pronounsstring
Common options include:
- she/her
- he/him
- they/them
- Not specified
You may also provide a custom string.
photoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
emailstring · email
phonestring
notesstring · html
Additional notes about a Person. Supports basic HTML tags and formatting.

UpdatePersonOutput

personobject · required

CreateConsumableInput

orgIdstring · uuid · required
The id of the Organization that owns this Consumable.
namestring · required
colorstring · required
Hex color code (without the # symbol).

symbolinteger · required

The visual symbol representing this Consumable.

Value	Symbol
0	COFFEE_BEAN
1	COOKIE
2	BEER_STEIN
3	BOWL_STEAM
4	CARROT
5	ORANGE_SLICE
6	BEER_BOTTLE
7	BOWL_FOOD
8	HAMBURGER
9	PIZZA
10	PEPPER
11	DROP
12	WINE
13	FORK_KNIFE
14	AVOCADO
15	BRANDY
16	COFFEE
17	ONIGIRI
18	SHRIMP
19	ACORN
20	BREAD
21	CHEESE
22	CHERRIES
23	COOKING_POT
24	EGG
25	FISH
26	ICE_CREAM
27	DISCO_BALL
28	CHAMPAGNE
29	CALL_BELL
30	CONFETTI
31	TICKET
32	BALLOON
33	HIGH_HEEL
34	PANTS
35	SNEAKER
36	BASEBALL_CAP
37	BAG
38	BICYCLE
39	FACE_MASK
40	BANDAIDS_FILL
41	ARMCHAIR
42	CHAIR
43	BROOM
44	POTTED_PLANT
45	BASKET
46	LADDER
47	FAN
48	LIGHTBULB
49	KNIFE
50	LIGHTNING
51	BLUEPRINT
52	HAMMER
53	PAINT_ROLLER
54	PAINT_BRUSH
55	BOOK_OPEN_TEXT
56	PEN_NIB
57	PALETTE
58	CLIPBOARD
59	PIANO_KEYS
60	SPEAKER_HIFI
61	BOOK
62	PAPERCLIP
63	PAINT_BUCKET
64	GUITAR
65	MICROPHONE_STAGE
66	GAME_CONTROLLER
67	PENCIL
68	APERTURE
69	BATTERY_FULL

pricesobject · required
A map of PriceTier ids to prices.

coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
detailsstring · html
Supports basic HTML tags and formatting.

UpdateConsumableInput

namestring
colorstring
Hex color code (without the # symbol).

symbolinteger

The visual symbol representing this Consumable.

Value	Symbol
0	COFFEE_BEAN
1	COOKIE
2	BEER_STEIN
3	BOWL_STEAM
4	CARROT
5	ORANGE_SLICE
6	BEER_BOTTLE
7	BOWL_FOOD
8	HAMBURGER
9	PIZZA
10	PEPPER
11	DROP
12	WINE
13	FORK_KNIFE
14	AVOCADO
15	BRANDY
16	COFFEE
17	ONIGIRI
18	SHRIMP
19	ACORN
20	BREAD
21	CHEESE
22	CHERRIES
23	COOKING_POT
24	EGG
25	FISH
26	ICE_CREAM
27	DISCO_BALL
28	CHAMPAGNE
29	CALL_BELL
30	CONFETTI
31	TICKET
32	BALLOON
33	HIGH_HEEL
34	PANTS
35	SNEAKER
36	BASEBALL_CAP
37	BAG
38	BICYCLE
39	FACE_MASK
40	BANDAIDS_FILL
41	ARMCHAIR
42	CHAIR
43	BROOM
44	POTTED_PLANT
45	BASKET
46	LADDER
47	FAN
48	LIGHTBULB
49	KNIFE
50	LIGHTNING
51	BLUEPRINT
52	HAMMER
53	PAINT_ROLLER
54	PAINT_BRUSH
55	BOOK_OPEN_TEXT
56	PEN_NIB
57	PALETTE
58	CLIPBOARD
59	PIANO_KEYS
60	SPEAKER_HIFI
61	BOOK
62	PAPERCLIP
63	PAINT_BUCKET
64	GUITAR
65	MICROPHONE_STAGE
66	GAME_CONTROLLER
67	PENCIL
68	APERTURE
69	BATTERY_FULL

coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
pricesobject
A map of PriceTier ids to prices.
detailsstring · html
Supports basic HTML tags and formatting.

CreateTagInput

orgIdstring · uuid · required
The id of the Organization to which this Tag belongs.
namestring · required
Display name of the Tag.
colorstring · hex · required
A color hex code string without the leading #.

symbolinteger · required

The visual symbol representing this Tag.

Value	Name
0	CLIPBOARD
1	BROOM
2	CAMERA
3	CAR
4	HAMMER
5	HEADSET
6	KEY
7	LADDER
8	LAPTOP
9	LIGHTBULB
10	MONITOR
11	PLUG
12	STOOL
13	TRUCK
14	VIDEO_CAMERA
15	WRENCH
16	COFFEE
17	COOKIE
18	PEPPER
19	FLOWER
20	DROP
21	MOON
22	RAINBOW
23	SUN
24	EAR
25	EYE
26	FACE_MASK
27	PERSON
28	SMILEY
29	WHEELCHAIR
30	SWORD
31	COAT_HANGER
32	DRESS
33	CROWN
34	HIGH_HEEL
35	PANTS
36	SNEAKER
37	CHAMPAGNE
38	GRADUATION_CAP
39	CASTLE_TURRET
40	HOUSE
41	PAINT_BUCKET
42	FILM_SLATE
43	HANDS_CLAPPING
44	MAGIC_WAND
45	MASK_HAPPY
46	MASK_SAD
47	TICKET
48	MICROPHONE_STAGE
49	MUSIC_NOTES
50	SPEAKER_HIFI
51	MONEY
52	CIRCLES_THREE
53	ASTERISK
54	HEXAGON
55	CLUB
56	DIAMOND
57	HEART
58	LIGHTNING
59	SPADE
60	SPARKLE
61	STAR
62	TRIANGLE
63	CLOCK
64	FLAG
65	GLOBE
66	BOOK
67	MEGAPHONE
68	TAG
69	WARNING

allowOnobject · required
Controls what type of entity a Tag can be associated with.

UpdateTagInput

namestring
Display name of the Tag.
colorstring · hex
A color hex code string without the leading #.

symbolinteger

The visual symbol representing this Tag.

Value	Name
0	CLIPBOARD
1	BROOM
2	CAMERA
3	CAR
4	HAMMER
5	HEADSET
6	KEY
7	LADDER
8	LAPTOP
9	LIGHTBULB
10	MONITOR
11	PLUG
12	STOOL
13	TRUCK
14	VIDEO_CAMERA
15	WRENCH
16	COFFEE
17	COOKIE
18	PEPPER
19	FLOWER
20	DROP
21	MOON
22	RAINBOW
23	SUN
24	EAR
25	EYE
26	FACE_MASK
27	PERSON
28	SMILEY
29	WHEELCHAIR
30	SWORD
31	COAT_HANGER
32	DRESS
33	CROWN
34	HIGH_HEEL
35	PANTS
36	SNEAKER
37	CHAMPAGNE
38	GRADUATION_CAP
39	CASTLE_TURRET
40	HOUSE
41	PAINT_BUCKET
42	FILM_SLATE
43	HANDS_CLAPPING
44	MAGIC_WAND
45	MASK_HAPPY
46	MASK_SAD
47	TICKET
48	MICROPHONE_STAGE
49	MUSIC_NOTES
50	SPEAKER_HIFI
51	MONEY
52	CIRCLES_THREE
53	ASTERISK
54	HEXAGON
55	CLUB
56	DIAMOND
57	HEART
58	LIGHTNING
59	SPADE
60	SPARKLE
61	STAR
62	TRIANGLE
63	CLOCK
64	FLAG
65	GLOBE
66	BOOK
67	MEGAPHONE
68	TAG
69	WARNING

allowOnobject
Controls what type of entity a Tag can be associated with.

CreateFileInput

orgIdstring · uuid · required
The id of the Organization that owns this File.
namestring · required
The display name for the uploaded File.
filestring · binary · required
Binary payload (multipart/form-data file).

CreateFileOutput

fileobject

ListFilesOutput

filesobject

ReadFileOutput

fileobject

UpdateFileInput

namestring
The display name of the File.
filestring · binary
Binary payload to replace the existing content.

UpdateFileOutput

fileobject

BookingNotificationInput

tostring[]
Email addresses to send the notification to.
bodystring
The message body to include in the email.

CreateBookingInput

submissionboolean
Whether this booking was submitted by a non-admin user. Set to true for public submissions, false for admin-created Bookings.

bookingStatusinteger · enum

The initial Booking status for admin-created Bookings. If submission is true, has no effect.

Value	Name	Description
0	PENDING	The `Booking` is awaiting admin approval
1	APPROVED	The `Booking` has been approved and an `Event` has been created
2	DENIED	The `Booking` has been denied
3	CANCELED	The `Booking` has been canceled

Enum values:

eventIdstring · uuid
The id of the Event this Booking was created from. Only provided for admin-created Bookings, has no effect if submission is true.
orgIdstring · uuid
The id of the Organization that owns this Booking.
bookingModuleIdstring · uuid
The id of the BookingModule this Booking belongs to.
portalIdstring · uuid
The id of the Portal associated with this Booking.
customerIdstring · uuid
Optional id of a Customer to associate with this Booking.
contactIdstring · uuid
Optional id of an existing Contact to associate with this Booking.
contactobject
Answers to the contact portion of the booking form.
eventobject
Answers to the event portion of the booking form.
requestNotestring · html
A note to the BookingModule admin explaining the request. Supports basic HTML tags and formatting.
notificationobject
Used to send an approval notification for admin-created Bookings. Ignored if submission is true.

UpdateBookingInput

customerIdstring · uuid
The id of a Customer to associate with the Booking, or an empty string to clear the association.
contactIdstring · uuid
The id of a Contact to associate with the Booking, or an empty string to clear the association.

ApproveBookingInput

clientBookingLastUpdatedAtstring · date-time · required
The lastUpdated timestamp of the Booking on the client. Used to prevent approval of Bookings updated by the end-user without the admin's knowledge.
eventobject · required
Fields used to create a new Event linked to the Booking.
notificationobject · required
Email notification details.

customerIdstring · uuid
Optional id of a Customer to associate with this Booking.
contactIdstring · uuid
Optional id of a Contact to associate with this Booking.

DenyBookingInput

clientBookingLastUpdatedAtstring · date-time · required
The lastUpdated timestamp of the Booking on the client. Used to prevent denial of Bookings updated by the end-user without the admin's knowledge.
notificationobject · required
Email notification details.

CancelBookingInput

eventProcedureinteger · enum · required
Whether to cancel or delete the associated event.
Enum values:
0
1
notificationobject · required
Email notification details.

CreateBookingChangeRequestInput

bookingIdstring · uuid · required
The id of the Booking to modify.
cancellationboolean · required
Whether this BookingChangeRequest is to cancel the Booking.
contactobject · required
Updated answers to the contact portion of the booking form (all fields optional).
eventobject · required
Updated answers to the event portion of the booking form (all fields optional).

requestNotestring · html
A note to the BookingModule admin explaining the request. Supports basic HTML tags and formatting.

ApproveBookingChangeRequestInput

eventobject · required
Fields used to update the Event linked to the Booking.
notificationobject · required
Email notification details.

eventProcedureinteger · enum
If the BookingChangeRequest is a cancellation, specifies whether to cancel or delete the Event.

Value Name Description
0 CANCEL Mark the Event as canceled
1 DELETE Delete the Event entirely
Enum values:
0
1

DenyBookingChangeRequestInput

notificationobject · required
Email notification details.

CreateBookingOutput

bookingobject · required
The submitted Booking.

eventobject
The Event that was created or updated, if this was an admin-created Booking.

ListBookingsOutput

bookingsobject · required
A map of Booking ids to Bookings.

associatedEventsobject[]
A list of Events associated with the returned Bookings.

ReadBookingOutput

bookingobject · required

UpdateBookingOutput

bookingobject · required

ApproveBookingOutput

bookingobject · required
eventobject · required

DenyBookingOutput

bookingobject · required

CancelBookingOutput

bookingobject · required
eventobject · required
The canceled or deleted event, or null if the event was deleted.

CreateBookingChangeRequestOutput

changeRequestobject
bookingobject

ListBookingChangeRequestsOutput

changeRequestsobject · required

ReadBookingChangeRequestOutput

changeRequestobject · required

ApproveBookingChangeRequestOutput

bookingobject · required
eventobject · required
The updated event, or null if the event was deleted as part of the change request.

CreatePortalInput

orgIdstring · uuid · required
The id of the Organization that owns this Portal.
namestring · required
The display name of the Portal.
statusinteger · enum · required
The publish status of the Portal.

Value Name Description
0 LIVE The Portal is publicly accessible
1 DRAFT The Portal is in draft mode and not publicly accessible
Enum values:
0
1
authenticationrequired
Authentication settings for the Portal.

slugstring
The URL slug for this Portal. If not provided, a random string of six characters will be generated. Used to create the public link with the pattern https://portal.prosperoapp.com/{orgNamespace}/{slug}.

CreatePortalOutput

portalobject · required

ListPortalsOutput

portalsobject · required

ReadPortalOutput

portalobject · required

UpdatePortalInput

namestring
The display name of the Portal.
slugstring
The URL slug for this Portal. Used to create the public link with the pattern https://portal.prosperoapp.com/{orgNamespace}/{slug}.
statusinteger · enum
The publish status of the Portal.

Value Name Description
0 LIVE The Portal is publicly accessible
1 DRAFT The Portal is in draft mode and not publicly accessible
Enum values:
0
1
authentication
Authentication settings for the Portal.

UpdatePortalOutput

portalobject · required

CreateBookingModuleInput

orgIdstring · uuid · required
The id of the Organization that owns this BookingModule.
namestring · required
The display name of the BookingModule.
adminIdstring · uuid · required
The id of the User who receives email notifications related to this BookingModule. This User will also have their email address included in the footer of automated emails sent to bookers.
portalIdsstring[] · required
The ids of Portals associated with this BookingModule.
configobject · required
Global configuration settings for the BookingModule.
aboutobject · required
Configuration of the About page of the BookingModule.
calendarobject · required
Configuration of the Calendar page of the BookingModule.
bookingFormobject · required
Configuration of the booking form of the BookingModule.

Important: When creating a BookingModule, custom fields should be provided WITHOUT id fields. The system will assign ids during creation. The created BookingModule will include ids for all custom fields.
spacesobject · required
A map of Space ids bookable in the BookingModule to their configuration.

A Space can only be included if its parent Venue is present in the venueIds field.

CreateBookingModuleOutput

bookingModuleobject · required

ListBookingModulesOutput

bookingModulesobject · required

ReadBookingModuleOutput

bookingModuleobject · required

UpdateBookingModuleInput

namestring
The display name of the BookingModule.
adminIdstring · uuid
The id of the User who receives email notifications related to this BookingModule. This User will also have their email address included in the footer of automated emails sent to bookers.
configobject
Partial updates to global configuration settings.
aboutobject
Partial updates to the About page configuration.
calendarobject
Partial updates to the Calendar page configuration.
bookingFormobject
Partial updates to booking form configuration.
addedSpacesobject
New Spaces and their configurations to add, keyed by Space id.

A Space can only be included if its parent Venue is present in the venueIds field.
updatedSpacesobject
Partial updates to existing Space configurations, keyed by Space id.
removedSpaceIdsstring[]
Ids of Spaces to remove.

UpdateBookingModuleOutput

bookingModuleobject · required

Booking

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid
The id of the Organization that owns this Booking.
bookingModuleIdstring · uuid
The id of the BookingModule this Booking belongs to.
portalIdstring · uuid
The id of the Portal associated with this Booking.
eventIdstring · uuid
If applicable, the id of the Event created from this approved Booking. Absent if the Booking is not approved.
customerIdstring · uuid
If applicable, the id of the Customer associated with this Booking.
contactIdstring · uuid
If applicable, the id of the Contact associated with this Booking.

statusinteger · enum

The status of a Booking.

Value	Name	Description
0	PENDING	The `Booking` is awaiting admin approval
1	APPROVED	The `Booking` has been approved and an `Event` has been created
2	DENIED	The `Booking` has been denied
3	CANCELED	The `Booking` has been canceled

Enum values:

contactobject
Answers to the contact portion of the booking form.
eventobject
Answers to the event portion of the booking form.
requestNotestring · html
A note to the BookingModule admin explaining the request. Supports basic HTML tags and formatting.

BookingChangeRequest

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly · required
The id of the Organization that owns this BookingChangeRequest.
bookingIdstring · uuid · required
The id of the Booking to modify.
cancellationboolean · required
Whether this BookingChangeRequest is to cancel the Booking.
contactobject · required
Updated answers to the contact portion of the booking form (all fields optional).
eventobject · required
Updated answers to the event portion of the booking form (all fields optional).

requestNotestring · html
A note to the BookingModule admin explaining the request. Supports basic HTML tags and formatting.

Comment

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this Comment.
archivedboolean · readOnly
Whether this Comment has been archived.
regardingobject · readOnly
Information about the entity this Comment is attached to.
userIdstring · uuid · readOnly
The id of the User that created this Comment.
bodystring · html
The content of the Comment. Supports basic HTML tags and formatting.
resolvedboolean
Whether this Comment has been resolved.
resolvedByIdstring · uuid
If applicable, the id of the User that resolved this Comment. Absent if the Comment is unresolved.

CommentCreated_Notification

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

causeinteger · enum · readOnly
The reason this Notification was created.

0 = COMMENT_CREATED, 1 = USER_MENTIONED
Enum values:
0
1
causeDataobject

Consumable

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · required
The id of the Organization that owns this Consumable.
namestring · required
colorstring · required
Hex color code (without the # symbol).

symbolinteger · required

The visual symbol representing this Consumable.

Value	Symbol
0	COFFEE_BEAN
1	COOKIE
2	BEER_STEIN
3	BOWL_STEAM
4	CARROT
5	ORANGE_SLICE
6	BEER_BOTTLE
7	BOWL_FOOD
8	HAMBURGER
9	PIZZA
10	PEPPER
11	DROP
12	WINE
13	FORK_KNIFE
14	AVOCADO
15	BRANDY
16	COFFEE
17	ONIGIRI
18	SHRIMP
19	ACORN
20	BREAD
21	CHEESE
22	CHERRIES
23	COOKING_POT
24	EGG
25	FISH
26	ICE_CREAM
27	DISCO_BALL
28	CHAMPAGNE
29	CALL_BELL
30	CONFETTI
31	TICKET
32	BALLOON
33	HIGH_HEEL
34	PANTS
35	SNEAKER
36	BASEBALL_CAP
37	BAG
38	BICYCLE
39	FACE_MASK
40	BANDAIDS_FILL
41	ARMCHAIR
42	CHAIR
43	BROOM
44	POTTED_PLANT
45	BASKET
46	LADDER
47	FAN
48	LIGHTBULB
49	KNIFE
50	LIGHTNING
51	BLUEPRINT
52	HAMMER
53	PAINT_ROLLER
54	PAINT_BRUSH
55	BOOK_OPEN_TEXT
56	PEN_NIB
57	PALETTE
58	CLIPBOARD
59	PIANO_KEYS
60	SPEAKER_HIFI
61	BOOK
62	PAPERCLIP
63	PAINT_BUCKET
64	GUITAR
65	MICROPHONE_STAGE
66	GAME_CONTROLLER
67	PENCIL
68	APERTURE
69	BATTERY_FULL

pricesobject · required
A map of PriceTier ids to prices.

coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
detailsstring · html
Supports basic HTML tags and formatting.

Contact

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · required
The id of the Organization that owns this Contact.
customerIdstring · uuid · required
The id of the Customer that owns this Contact.
fullNamestring · required
The full name of the Contact.

titlestring
The job title of the Contact.
emailstring · email
The email address of the Contact.
phonestring
The phone number of the Contact.
detailsstring · html
Supports basic HTML tags and formatting.

Customer

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · required
The id of the Organization that owns this Customer.
namestring · required

addressobject
A physical address.
einstring
The Employer Identification Number (EIN) of the Customer, or international equivalent outside of the United States, like the Chamber of Commerce number.
vatNumberstring
The VAT registration number of the Customer (not used in the United States).
emailstring · email
The general email address of the Customer, like [email protected].
phonestring
The general phone number of the Customer.
detailsstring · html
Supports basic HTML tags and formatting.

Event

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this Event.
archivedboolean · readOnly
Whether this Event has been archived.
titlestring
start
The start time of this Event. All-day Events have a date but no time. Timed Events have a UTC timestamp.
end
The end time of this Event. All-day Events have a date but no time. Timed Events have a UTC timestamp.
detailsstring · html
Supports basic HTML tags and formatting.
adminNotesstring · html
Supports basic HTML tags and formatting. Never visible in View links, BookingModules, or synced to third-party calendars.
statusinteger · enum
The status of an Event.

0 = TENTATIVE, 1 = CONFIRMED, 2 = CANCELED, 3 = HOLD_1, 4 = HOLD_2, 5 = HOLD_3
Enum values:
0
1
2
3
4
5
flagboolean
Adds a visual flag to the Event.
draftboolean
If true, the Event is not visible in View links, BookingModules, and not synced to third-party calendars.
commentCountinteger · readOnly
The number of Comments on this Event.
bookingIdstring · uuid · readOnly
If applicable, the id of the Booking that created this Event. Absent if the Event was not created by a Booking.
locationIdsstring[]
The ids of the Locations associated with this Event. Can include Spaces and/or Venues.
projectsIdsstring[]
The ids of the Projects associated with this Event.
roleGroupIdsstring[]
The ids of the RoleGroups associated with this Event.
roleIdsstring[]
The ids of the Roles associated with this Event.
groupIdsstring[]
The ids of the Groups associated with this Event. Can include People-based Groups and/or Item-based Collections.
personIdsstring[]
The ids of the People associated with this Event.
itemIdsstring[]
The ids of the Items associated with this Event.
consumablesobject[]
The ids and quantities of the Consumables associated with this Event.
tagIdsstring[]
The ids of the Tags associated with this Event.
fileIdsstring[]
The ids of the Files associated with this Event.

File

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this File.
namestring
Display name of the File.
sizeinteger · int64
The size of the File binary in bytes.
typestring
The extension of the File binary (e.g., pdf, jpg, mp4).

Group

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this Group.
namestring
The name of the Group.
typeinteger · enum
The type of entities a Group contains.

Value Name Description
0 PEOPLE A Group of People
1 ITEMS A Collection of Items
Enum values:
0
1
entityIdsstring[]
The ids of the entities in this Group. For PEOPLE Groups, these are Person ids. For ITEMS Groups (also called Collections), these are Item ids.
notesstring
Supports basic HTML tags and formatting.

Item

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this Item.
itemSetIdstring · uuid · readOnly
The id of the ItemSet this Item belongs to.
customIdstring
Optional custom identifier for the Item.
defaultLocationIdstring · uuid
If applicable, the default Location for this Item.
conditioninteger · enum
The physical condition of an Item.

Value Name
0 FUNCTIONAL
1 NEEDS_REPAIR
2 UNDER_REPAIR
Enum values:
0
1
2
lifecycleStatusinteger · enum
The lifecycle status of an Item.

Value Name
0 IN_TRANSIT
1 OWNED
2 DISCARDED
Enum values:
0
1
2

ItemSet

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this ItemSet.
namestring
The name of the ItemSet.
colorstring
Hex color code (without #).
photoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
pricesobject
A map of PriceTier ids to prices.
detailsstring · html
Supports basic HTML tags and formatting.
fileIdsstring[]
The ids of Files attached to this ItemSet.
tagIdsstring[]
The ids of Tags attached to this ItemSet.
itemIdsstring[] · readOnly
The ids of Items in this ItemSet.

Location

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object · requires: id, createdAt, lastUpdatedAt +6 more
	type = object · requires: id, createdAt, lastUpdatedAt +6 more

Properties for Variant 1:

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · required
The id of the Organization that owns this Venue.
namestring · required
colorstring · required
Hex color code (no #)
pricesobject · required
A map of PriceTier ids to prices.
typeinteger · enum · required
The type of the Location - Venue or Space

0 = VENUE, 1 = SPACE
Enum values:
0
1
spaceIdsstring[] · required
The ids of the Spaces contained within this Venue.

coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
detailsstring · html
Supports basic HTML tags and formatting.
addressobject
A physical address.

Notification

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

causeinteger · enum · readOnly
The reason this Notification was created.

0 = COMMENT_CREATED, 1 = USER_MENTIONED
Enum values:
0
1
causeDataobject

NotificationBase

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this Notification.
userIdstring · uuid · readOnly
The id of the User that this Notification is for.
isReadboolean
Whether this Notification has been marked as read.

Organization

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
namestring
Displayed in the admin app and email notifications.
namespacestring
A globally unique namespace across all Prospero Organizations. Used to create routes for View links and Portal URLs.
logoIdstring · uuid
The UUID of an image stored in Cloudflare Images. Used in the center of generated QR codes.
userIdsstring[] · readOnly
The ids of the Users that are members of this Organization.
orgInvitationIdsstring[] · readOnly
The ids of the OrganizationInvitations that are pending for this Organization.
localeinteger · enum
The preferred language and dialect of the Organization. Used to generate localized Offers and Invoices.

1 = UNITED_STATES_ENGLISH, 2 = NETHERLANDS_DUTCH, 3 = NETHERLANDS_ENGLISH, 4 = UNITED_KINGDOM_ENGLISH
Enum values:
1
2
3
4
displayCurrencyinteger · enum
Used as the default currency when defining prices for entities and generating Offers and Invoices.

0 = USD, 1 = EUR, 2 = GBP
Enum values:
0
1
2
billingAdminSettingsobject
Settings used when generating Offers and Invoices.
archivalSettingsobject
Settings for automatic archiving of entities.

Person

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · required
The id of the Organization that owns this Person.
legalFirstNamestring · required
legalLastNamestring · required

stageNamestring
The name the Person goes by when performing. This name has highest priority when rendering the Person's name throughout the platform.
nicknamestring
The name the Person goes by informally. This name is preferred over the Person's legal name when rendering the Person's name throughout the platform, though superceded by the Person's stageName.
titlestring
The job title of the Person.
pronounsstring
Common options include:
- she/her
- he/him
- they/them
- Not specified
You may also provide a custom string.
photoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
emailstring · email
phonestring
notesstring · html
Additional notes about a Person. Supports basic HTML tags and formatting.

PriceTier

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · required
ISO 8601 datetime when the price tier was created.
lastUpdatedAtstring · date-time · required
ISO 8601 datetime when the price tier was last updated.
orgIdstring · uuid · required
The id of the Organization that owns this PriceTier.
namestring · required
Display name of the price tier.

Portal

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly · required
The id of the Organization that owns this Portal.
namestring · required
The display name of the Portal.
slugstring · required
The URL slug for this Portal. Used to create the public link with the pattern https://portal.prosperoapp.com/{orgNamespace}/{slug}.
statusinteger · enum · required
The publish status of the Portal.

Value Name Description
0 LIVE The Portal is publicly accessible
1 DRAFT The Portal is in draft mode and not publicly accessible
Enum values:
0
1
authenticationrequired
Authentication settings for the Portal.

bookingModuleIdstring · uuid
The id of the BookingModule associated with this Portal. This field will be deprecated once more Modules are released.

BookingModule

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly · required
The id of the Organization that owns this BookingModule.
namestring · required
The display name of the BookingModule.
adminIdstring · uuid · required
The id of the User who receives email notifications related to this BookingModule. This User will also have their email address included in the footer of automated emails sent to bookers.
configobject · required
Global configuration settings for the BookingModule.
aboutobject · required
Configuration of the About page of the BookingModule.
calendarobject · required
Configuration of the Calendar page of the BookingModule.
bookingFormobject · required
Configuration of the booking form of the BookingModule.
spacesobject · required
A map of Space ids bookable in the BookingModule to their configuration.

A Space can only be included if its parent Venue is present in the venueIds field.

Project

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this Project.
namestring
Display name of the Project.
shortNamestring
Optional abbreviated name of the Project.
colorstring · hex...
A color hex code string without the leading #.
detailsstring · html
Optional details or notes about the Project. Supports basic HTML tags and formatting.
coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
keyDatesobject[]
Important dates associated with the Project.
subscribedToEventsboolean · readOnly
Whether the requesting User has an active Subscription to all Events associated with this Project.

Role

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this Role.
projectIdstring · uuid
If applicable, the id of the Project this Role belongs to. Absent if the Role is Organization-wide.
namestring
The name of the Role.
colorstring
Hex color code (without #).
personIdstring · uuid
If applicable, the id of the Person assigned to this Role. Absent if no Person is assigned.

symbolinteger · enum

The symbol icon for a Role or RoleGroup.

Value	Name
0	ALIEN
1	BABY
2	DETECTIVE
3	GHOST
4	MASK_HAPPY
5	MASK_SAD
6	SKULL
7	ROBOT
8	BASEBALL_CAP
9	CHEF_HAT
10	COWBOY_HAT
11	CROWN
12	FOOTBALL_HELMET
13	GRADUATION_CAP
14	HARD_HAT
15	HANDSHAKE
16	PERSON
17	KNIFE
18	MAGIC_WAND
19	SWORD
20	TROPHY
21	BACKPACK
22	COAT_HANGER
23	DRESS
24	EYEGLASSES
25	HAIR_DRYER
26	HIGH_HEEL
27	BOOK_OPEN_TEXT
28	CAMERA
29	CLIPBOARD
30	FILM_SLATE
31	HEADSET
32	MEGAPHONE
33	OFFICE_CHAIR
34	PEN_NIB
35	STAR
36	VIDEO_CAMERA
37	BLUEPRINT
38	HAMMER
39	LADDER
40	PAINT_BRUSH
41	WRENCH
42	BEER_STEIN
43	BOWL_STEAM
44	CARROT
45	COFFEE
46	COOKIE
47	FORK_KNIFE
48	ORANGE_SLICE
49	WINE
50	EQUALIZER
51	GUITAR
52	MICROPHONE_STAGE
53	MUSIC_NOTES
54	PIANO_KEYS
55	SPEAKER_HIFI
56	BROOM
57	BUILDING
58	CAR
59	KEY
60	CALL_BELL
61	CONFETTI
62	MONEY
63	PHONE
64	SHIELD_STAR
65	TICKET
66	TRAFFIC_CONE
67	LIGHTBULB
68	PLUG
69	LAPTOP

Enum values:

detailsstring · html
Supports basic HTML tags and formatting.
pricesobject
A map of PriceTier ids to prices.

RoleGroup

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this RoleGroup.
projectIdstring · uuid
If applicable, the id of the Project this RoleGroup belongs to. Absent if the RoleGroup is Organization-wide.
namestring
The name of the RoleGroup.
colorstring
Hex color code (without #).

symbolinteger · enum

The symbol icon for a Role or RoleGroup.

Value	Name
0	ALIEN
1	BABY
2	DETECTIVE
3	GHOST
4	MASK_HAPPY
5	MASK_SAD
6	SKULL
7	ROBOT
8	BASEBALL_CAP
9	CHEF_HAT
10	COWBOY_HAT
11	CROWN
12	FOOTBALL_HELMET
13	GRADUATION_CAP
14	HARD_HAT
15	HANDSHAKE
16	PERSON
17	KNIFE
18	MAGIC_WAND
19	SWORD
20	TROPHY
21	BACKPACK
22	COAT_HANGER
23	DRESS
24	EYEGLASSES
25	HAIR_DRYER
26	HIGH_HEEL
27	BOOK_OPEN_TEXT
28	CAMERA
29	CLIPBOARD
30	FILM_SLATE
31	HEADSET
32	MEGAPHONE
33	OFFICE_CHAIR
34	PEN_NIB
35	STAR
36	VIDEO_CAMERA
37	BLUEPRINT
38	HAMMER
39	LADDER
40	PAINT_BRUSH
41	WRENCH
42	BEER_STEIN
43	BOWL_STEAM
44	CARROT
45	COFFEE
46	COOKIE
47	FORK_KNIFE
48	ORANGE_SLICE
49	WINE
50	EQUALIZER
51	GUITAR
52	MICROPHONE_STAGE
53	MUSIC_NOTES
54	PIANO_KEYS
55	SPEAKER_HIFI
56	BROOM
57	BUILDING
58	CAR
59	KEY
60	CALL_BELL
61	CONFETTI
62	MONEY
63	PHONE
64	SHIELD_STAR
65	TICKET
66	TRAFFIC_CONE
67	LIGHTBULB
68	PLUG
69	LAPTOP

Enum values:

roleIdsstring[]
The ids of the Roles in this RoleGroup.
detailsstring · html
Supports basic HTML tags and formatting.

Space

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · required
The id of the Organization that owns this Space.
namestring · required
colorstring · required
Hex color code (no #)
pricesobject · required
A map of PriceTier ids to prices.
typeinteger · enum · required
The type of the Location - Venue or Space

0 = VENUE, 1 = SPACE
Enum values:
0
1
venueIdstring · uuid · required
The id of the parent Venue of this Space.

coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
detailsstring · html
Supports basic HTML tags and formatting.

Tag

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
The id of the Organization that owns this Tag.
namestring
Display name of the Tag.
colorstring · hex
A color hex code string without the leading #.

symbolinteger

The visual symbol representing this Tag.

Value	Name
0	CLIPBOARD
1	BROOM
2	CAMERA
3	CAR
4	HAMMER
5	HEADSET
6	KEY
7	LADDER
8	LAPTOP
9	LIGHTBULB
10	MONITOR
11	PLUG
12	STOOL
13	TRUCK
14	VIDEO_CAMERA
15	WRENCH
16	COFFEE
17	COOKIE
18	PEPPER
19	FLOWER
20	DROP
21	MOON
22	RAINBOW
23	SUN
24	EAR
25	EYE
26	FACE_MASK
27	PERSON
28	SMILEY
29	WHEELCHAIR
30	SWORD
31	COAT_HANGER
32	DRESS
33	CROWN
34	HIGH_HEEL
35	PANTS
36	SNEAKER
37	CHAMPAGNE
38	GRADUATION_CAP
39	CASTLE_TURRET
40	HOUSE
41	PAINT_BUCKET
42	FILM_SLATE
43	HANDS_CLAPPING
44	MAGIC_WAND
45	MASK_HAPPY
46	MASK_SAD
47	TICKET
48	MICROPHONE_STAGE
49	MUSIC_NOTES
50	SPEAKER_HIFI
51	MONEY
52	CIRCLES_THREE
53	ASTERISK
54	HEXAGON
55	CLUB
56	DIAMOND
57	HEART
58	LIGHTNING
59	SPADE
60	SPARKLE
61	STAR
62	TRIANGLE
63	CLOCK
64	FLAG
65	GLOBE
66	BOOK
67	MEGAPHONE
68	TAG
69	WARNING

allowOnobject
Controls what type of entity a Tag can be associated with.

User

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
fullNamestring
Displayed in the admin app and email notifications.
emailstring · email
Used for authentication and email notifications.
photoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
orgIdsstring[] · readOnly
The ids of the Organizations the User is a member of.
accountStatusinteger · enum
The status of the User's account. Active accounts can login and access the Prospero API. Deactivated accounts cannot login nor access the Prospero API.

0 = ACTIVE, 1 = DEACTIVATED
Enum values:
0
1
onboardedboolean · readOnly
Whether the User has completed the initial onboarding process. Users that are not onboarded will not be able to access the admin application without completing onboarding.
authorizationobject
The permission levels for access to the admin application and Prospero API.
googleobject
Google integration settings.
microsoftobject · readOnly
Microsoft integration settings.

UserMentioned_Notification

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

oneOf

Exactly one variant must match.

Decision Table

Variant	Matching Criteria
	type = object
	type = object

Properties for Variant 1:

causeinteger · enum · readOnly
The reason this Notification was created.

0 = COMMENT_CREATED, 1 = USER_MENTIONED
Enum values:
0
1
causeDataobject

Venue

idstring · uuid · readOnly · required
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly · required
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · required
The id of the Organization that owns this Venue.
namestring · required
colorstring · required
Hex color code (no #)
pricesobject · required
A map of PriceTier ids to prices.
typeinteger · enum · required
The type of the Location - Venue or Space

0 = VENUE, 1 = SPACE
Enum values:
0
1
spaceIdsstring[] · required
The ids of the Spaces contained within this Venue.

coverPhotoIdstring · uuid
The UUID of an image stored in Cloudflare Images.
detailsstring · html
Supports basic HTML tags and formatting.
addressobject
A physical address.

View

idstring · uuid · readOnly
The globally unique identifier of this entity. Prospero uses v1 UUIDs.
createdAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
lastUpdatedAtstring · date-time · readOnly
An ISO 8601-compliant datetime string, formatted YYYY-MM-DDThh:mm:ssZ.
orgIdstring · uuid · readOnly
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}.
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.