Skip to content
Cohost API
Select theme
Dark
Light
Auto
Guides
Introduction
Quick Start
Authentication
API Keys
Using the API
API Reference
Overview
Events
Overview
List events for the authenticated context
Get event profile
Coupons
Overview
List coupons
Create a new coupon
Delete a coupon
Update an existing coupon
Orders
Overview
List orders for the authenticated user's company (PG-backed)
Create order
Fix order issues (missing includes, incorrect types)
Get order details
Update an existing order
Get order attendees
Get order audit log
Resend order confirmation email
Transfer order to new context
Company
Overview
List organizers for the authenticated company
Create or upsert an organizer
Get a single organizer by ID
Delete an organizer by ID
Update an existing organizer
Price Adjustments
List available effect formulas
Evaluate price adjustments for an offering
List price adjustments
Create a price adjustment
Get a price adjustment
Delete a price adjustment
Update a price adjustment
Event Tickets
Get event tickets
Create event tickets
Delete a ticket
Update a ticket
Get tickets for a specific instance
Event Instances
Get all instances for a series
Create a new instance
Get a single populated instance
Delete an instance
Update an instance
Get resolved instance with metadata
Revert fields to parent values
Create multiple instances
Purchase Groups
Get all purchase groups for an event
Get a specific purchase group
Delete a purchase group
Update a purchase group (preferred method)
Split a purchase group
Merge two purchase groups
Cost Components
List cost components
Create cost component
Get cost component by ID
Delete cost component
Update cost component
Cart
Start a new cart session
Get a cart session by ID
Cancel (soft delete) a cart session
Update a cart session
Add, update, or remove an item (ticket) in a cart session
Join a table commitment within a cart session
Finalize the cart session and place the order
Schemas
Address
AuditActor
AuditEntry
AuthInitResult
AuthProviderCapabilities
AuthProviderRecord
CalculatedCostComponent
ChannelApplicationPayloadBase
ClaimTransferRequest
CompanyDoc
CompleteUploadRequest
CompleteUploadResponse
CostBase
CostComponent
CostComponentCap
CostComponentDoc
CostComponentRule
CostComponentRuleCondition
CostOp
Coupon
CouponSummary
CreatePricingRule
Customer
DataRecord
Device
DisplayCost
DisplayEventProfile
EventBase
EventMeta
ExtendedOffering
GeometryPoint
IAMApp
IAMGrant
IAMRole
InitiateTransferRequest
InitMultipleUploadFile
InitMultipleUploadRequest
InitMultipleUploadResponse
InitMultipleUploadSession
InitUploadRequest
InitUploadResponse
LadderConfig
LadderTranche
Location
LocationGeometry
ManualBump
Media
MediaUploadRecord
MultipartText
Offering
OfferingCosts
OfferingOption
OfferingOptionsGroup
OfferingSnapshot
OrderCosts
OrderItem
OrderItemCosts
OTP
OTPRecord
OTPRequestInput
OTPVerifyInput
PackageIncluded
PackageOffering
PaginationResponse
Passkey
PasskeyChallenge
PasskeyProviderData
PasskeyRecord
Person
PersonAddress
PersonContact
Photo
PriceChangeLog
PricingConfig
PricingOp
PricingRule
PricingState
PricingTier
Profile
PurchaseGroup
RefundLineItem
RefundRequest
RefundRequestNote
ResolvedCartContext
ResolvedCartContextOffering
Schedule
SSOProviderData
StructuredCost
StructuredDate
TableCommitmentOptions
Ticket
TicketTransfer
TicketWithTableCommitment
TieredConfig
TimeConfig
TimeTier
UpdatePricingRule
UpsertableDataRecord
VCDataRecord
VelocityConfig
VersionedDataRecord
Select theme
Dark
Light
Auto
OfferingOptionsGroup
Fields
Section titled “Fields”
Field
Type
Required
Description
id
string
✓
name
string
✓
hash
string
options
object[]
✓
