Ressivo API reference

Every action the Ressivo dashboard performs is available over a JSON HTTP API, authenticated with a key you issue yourself. This page documents 77 operations across 14 resource groups, generated from the same OpenAPI description the server validates incoming requests against.

Download the OpenAPI spec (JSON)

Getting started

Base URL

Every path below is relative to:

https://ressivo.com/api

Authentication

Create a key in the dashboard under /dashboard/ressivo?tab=settings&subtab=apikeys, then send it in the apikey header on every request:

curl 'https://ressivo.com/api/users/apikeys' \
  -H 'apikey: YOUR_API_KEY'

Three properties of a key matter before you build against it:

A key belongs to one organization. Every request is scoped to that organization's data. There is no cross-organization or account-wide key.
A key belongs to one product. A Ressivo key is refused with app_not_allowed on another product's endpoints, and with app_not_enabled if the organization has not enabled Ressivo.
A key can be read-only. A read-only key answers GET, HEAD and OPTIONS and returns read_only_key on anything that writes — the safer key to hand to a script or an assistant.

The dashboard authenticates with a session cookie instead, which is why operations below list both schemes. For an integration, the API key is the one you want.

Errors

Errors come back as JSON, with the HTTP status repeated in the body:

{ "statusCode": 403, "code": "read_only_key", "message": "Read-only API key" }

Status	Code	Meaning
`400`	`validation`	The request body or query does not match the schema.
`401`	`unauthorized`	No API key or session, or the key does not exist.
`403`	`forbidden`	The key is valid but not allowed to perform this operation.
`403`	`read_only_key`	A read-only key attempted a write.
`403`	`app_not_enabled`	The organization does not have this product enabled.
`403`	`app_not_allowed`	The key belongs to a different product.
`404`	`not_found`	No such route, or no such record in this organization.
`500`	`internal`	Unexpected server error.

Model Context Protocol

The same key authenticates an MCP endpoint, so an assistant can drive Ressivo directly instead of composing HTTP calls. It speaks Streamable HTTP and offers the operations below as tools, filtered to what the key is allowed to do:

https://ressivo.com/mcp
Authorization: Bearer YOUR_API_KEY

Reference

Search endpoints

Ressivo

Availability

get`/ressivo/availability`

List availability rules

Parameters

Name	In	Type	Required
`listingId`	query	`number`	yes

Responses

Status	Description	Body
`200`	List of availability rules	`RessivoAvailabilityRule[]`

Example

curl -X GET 'https://ressivo.com/api/ressivo/availability' \
  -H 'apikey: YOUR_API_KEY'

post`/ressivo/availability`

Create availability rule

Request body

application/json — RessivoAvailabilityInput

Responses

Status	Description	Body
`201`	Created availability rule	`RessivoAvailabilityRule`

Example

curl -X POST 'https://ressivo.com/api/ressivo/availability' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/ressivo/availability`

Update availability rule

Request body

application/json — RessivoAvailabilityUpdate

Responses

Status	Description	Body
`200`	Updated availability rule	`RessivoAvailabilityRule`

Example

curl -X PUT 'https://ressivo.com/api/ressivo/availability' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

get`/ressivo/availability/exceptions`

List availability exceptions for a date range

Parameters

Name	In	Type	Required
`listingId`	query	`number`	yes
`dateFrom`	query	`string`	yes
`dateTo`	query	`string`	yes
`itemId`	query	`integer`	no

Responses

Status	Description	Body
`200`	List of availability exceptions	`RessivoAvailabilityException[]`

Example

curl -X GET 'https://ressivo.com/api/ressivo/availability/exceptions' \
  -H 'apikey: YOUR_API_KEY'

post`/ressivo/availability/exceptions`

Toggle a slot exception (disable/re-enable)

Request body

application/json — { listingId, exceptionDate, slotTime, reason, itemId }

Responses

Status	Description	Body
`200`	Toggled exception	`RessivoAvailabilityException`

Example

curl -X POST 'https://ressivo.com/api/ressivo/availability/exceptions' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/ressivo/availability/exceptions`

Update exception reason

Request body

application/json — { id, reason }

Responses

Status	Description	Body
`200`	Updated exception	`RessivoAvailabilityException`

Example

curl -X PUT 'https://ressivo.com/api/ressivo/availability/exceptions' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

delete`/ressivo/availability/id/{id}`

Delete availability rule

Parameters

Name	In	Type	Required
`id`	path	`number`	yes

Responses

Status	Description	Body
`204`	Deleted availability rule

Example

curl -X DELETE 'https://ressivo.com/api/ressivo/availability/id/{id}' \
  -H 'apikey: YOUR_API_KEY'

Bookings

get`/ressivo/bookings`

List bookings

Parameters

Name	In	Type	Required
`listingId`	query	`number`	no

Responses

Status	Description	Body
`200`	List of bookings	`RessivoBooking[]`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/ressivo/bookings' \
  -H 'apikey: YOUR_API_KEY'

post`/ressivo/bookings`

Create a booking as an admin (bypasses payment)

Request body

application/json — RessivoAdminBookingInput

Responses

Status	Description	Body
`201`	Booking created	`RessivoBooking`
`400`	Validation error	`{ statusCode, code, message }`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/ressivo/bookings' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/ressivo/bookings`

Update booking status

Request body

application/json — RessivoBookingUpdate

Responses

Status	Description	Body
`200`	Updated booking	`RessivoBooking`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X PUT 'https://ressivo.com/api/ressivo/bookings' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

get`/ressivo/bookings/{id}`

Get booking

Parameters

Name	In	Type	Required
`listingId`	query	`number`	no
`id`	path	`number`	yes

Responses

Status	Description	Body
`200`	Booking	`RessivoBooking`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/ressivo/bookings/{id}' \
  -H 'apikey: YOUR_API_KEY'

Items

get`/ressivo/items`

List listing items

Parameters

Name	In	Type	Required
`listingId`	query	`number`	yes

Responses

Status	Description	Body
`200`	List of items	`RessivoItem[]`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/ressivo/items' \
  -H 'apikey: YOUR_API_KEY'

post`/ressivo/items`

Create listing item

Request body

application/json — RessivoItemInput
multipart/form-data — { listingId, name, description, bookingType, capacityMin, capacityMax, sharedCapacity, pricingMode, pricePerSlot, active, file }

Responses

Status	Description	Body
`201`	Created item	`RessivoItem`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/ressivo/items' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/ressivo/items`

Update listing item

Request body

application/json — RessivoItemUpdate
multipart/form-data — { id, listingId, name, description, bookingType, capacityMin, capacityMax, sharedCapacity, pricingMode, pricePerSlot, active, imageUrl, file }

Responses

Status	Description	Body
`200`	Updated item	`RessivoItem`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X PUT 'https://ressivo.com/api/ressivo/items' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

delete`/ressivo/items/id/{id}`

Delete listing item

Parameters

Name	In	Type	Required
`id`	path	`number`	yes

Responses

Status	Description	Body
`204`	Deleted item
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X DELETE 'https://ressivo.com/api/ressivo/items/id/{id}' \
  -H 'apikey: YOUR_API_KEY'

Listings

get`/ressivo/listings`

List listings

Responses

Status	Description	Body
`200`	List of listings	`RessivoListing[]`

Example

curl -X GET 'https://ressivo.com/api/ressivo/listings' \
  -H 'apikey: YOUR_API_KEY'

post`/ressivo/listings`

Create listing

Request body

application/json — RessivoListingInput
multipart/form-data — { name, tagline, primaryColor, secondaryColor, currency, timezone, contactEmail, cancellationPolicyUrl, refundPolicyUrl, daysOfWeek, startTime, endTime, slotDuration, active, logo, hero }

Responses

Status	Description	Body
`201`	Created listing	`RessivoListing`

Example

curl -X POST 'https://ressivo.com/api/ressivo/listings' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/ressivo/listings`

Update listing

Request body

application/json — RessivoListingUpdate
multipart/form-data — { id, name, tagline, primaryColor, secondaryColor, currency, timezone, contactEmail, cancellationPolicyUrl, refundPolicyUrl, daysOfWeek, startTime, endTime, slotDuration, active, logoFilename, logo, hero }

Responses

Status	Description	Body
`200`	Updated listing	`RessivoListing`

Example

curl -X PUT 'https://ressivo.com/api/ressivo/listings' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/ressivo/listings/custom-domain`

Set or update custom domain on a listing

Request body

application/json — { listingId, customDomain }

Responses

Status	Description	Body
`200`	Domain set

Example

curl -X PUT 'https://ressivo.com/api/ressivo/listings/custom-domain' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

post`/ressivo/listings/custom-domain/verify`

Verify DNS for custom domain

Request body

application/json — { listingId }

Responses

Status	Description	Body
`200`	Verification result

Example

curl -X POST 'https://ressivo.com/api/ressivo/listings/custom-domain/verify' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

delete`/ressivo/listings/custom-domain/{id}`

Remove custom domain from listing

Parameters

Name	In	Type	Required
`id`	path	`number`	yes

Responses

Status	Description	Body
`200`	Domain removed

Example

curl -X DELETE 'https://ressivo.com/api/ressivo/listings/custom-domain/{id}' \
  -H 'apikey: YOUR_API_KEY'

delete`/ressivo/listings/id/{id}`

Delete listing

Parameters

Name	In	Type	Required
`id`	path	`number`	yes

Responses

Status	Description	Body
`204`	Deleted

Example

curl -X DELETE 'https://ressivo.com/api/ressivo/listings/id/{id}' \
  -H 'apikey: YOUR_API_KEY'

Onboarding

get`/ressivo/onboarding`

Get first-run onboarding status

Responses

Status	Description	Body
`200`	Onboarding status	`RessivoOnboardingStatus`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/ressivo/onboarding' \
  -H 'apikey: YOUR_API_KEY'

post`/ressivo/onboarding/seed`

Apply the sample-data seed for a use case

Request body

application/json — RessivoOnboardingSeedInput

Responses

Status	Description	Body
`200`	Seed result (idempotent — repeats report alreadySeeded)	`RessivoOnboardingSeedResult`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/ressivo/onboarding/seed' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

delete`/ressivo/onboarding/seed`

Remove the organization's sample data

Responses

Status	Description	Body
`200`	Removal result	`RessivoOnboardingRemoveResult`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X DELETE 'https://ressivo.com/api/ressivo/onboarding/seed' \
  -H 'apikey: YOUR_API_KEY'

post`/ressivo/onboarding/skip`

Skip first-run onboarding

Responses

Status	Description	Body
`200`	Onboarding status after skipping	`RessivoOnboardingStatus`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/ressivo/onboarding/skip' \
  -H 'apikey: YOUR_API_KEY'

Public

get`/ressivo/public/calendar/{token}.ics`

iCal feed of a listing's confirmed bookings

Parameters

Name	In	Type	Required
`token`	path	`string`	yes

Responses

Status	Description	Body
`200`	iCalendar document	`string`

Example

curl -X GET 'https://ressivo.com/api/ressivo/public/calendar/{token}.ics' \
  -H 'apikey: YOUR_API_KEY'

get`/ressivo/public/resolve-domain`

Resolve a custom domain hostname to a listing slug

Parameters

Name	In	Type	Required
`hostname`	query	`string`	yes

Responses

Status	Description	Body
`200`	Resolved slug	`{ slug }`

Example

curl -X GET 'https://ressivo.com/api/ressivo/public/resolve-domain' \
  -H 'apikey: YOUR_API_KEY'

get`/ressivo/public/{slug}/availability`

List public availability rules

Parameters

Name	In	Type	Required
`slug`	path	`string`	yes

Responses

Status	Description	Body
`200`	List of availability rules	`RessivoAvailabilityRule[]`

Example

curl -X GET 'https://ressivo.com/api/ressivo/public/{slug}/availability' \
  -H 'apikey: YOUR_API_KEY'

get`/ressivo/public/{slug}/availability/exceptions`

List disabled slot times for a date

Parameters

Name	In	Type	Required
`slug`	path	`string`	yes
`date`	query	`string`	yes
`itemId`	query	`integer`	no

Responses

Status	Description	Body
`200`	Array of disabled slot times	`string[]`

Example

curl -X GET 'https://ressivo.com/api/ressivo/public/{slug}/availability/exceptions' \
  -H 'apikey: YOUR_API_KEY'

get`/ressivo/public/{slug}/availability/slot-counts`

Per-date count of remaining available slots for a listing

Parameters

Name	In	Type	Required
`slug`	path	`string`	yes
`dateFrom`	query	`string`	yes
`dateTo`	query	`string`	yes
`itemId`	query	`integer`	no

Responses

Status	Description	Body
`200`	Map of date (YYYY-MM-DD) to remaining-slot count	`object`

Example

curl -X GET 'https://ressivo.com/api/ressivo/public/{slug}/availability/slot-counts' \
  -H 'apikey: YOUR_API_KEY'

get`/ressivo/public/{slug}/availability/slot-occupancy`

Summed guest count per slot for an item on one date

Parameters

Name	In	Type	Required
`slug`	path	`string`	yes
`date`	query	`string`	yes
`itemId`	query	`integer`	yes

Responses

Status	Description	Body
`200`	Map of slot time (HH:MM) to summed guest count	`object`

Example

curl -X GET 'https://ressivo.com/api/ressivo/public/{slug}/availability/slot-occupancy' \
  -H 'apikey: YOUR_API_KEY'

post`/ressivo/public/{slug}/bookings`

Create a booking and return Stripe checkout

Parameters

Name	In	Type	Required
`slug`	path	`string`	yes

Request body

application/json — RessivoPublicBookingInput

Responses

Status	Description	Body
`201`	Booking created	`RessivoPublicBookingResponse`
`400`	Validation error	`{ statusCode, code, message }`
`403`	Forbidden	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/ressivo/public/{slug}/bookings' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

get`/ressivo/public/{slug}/bookings/{id}`

Get booking status

Parameters

Name	In	Type	Required
`slug`	path	`string`	yes
`id`	path	`number`	yes

Responses

Status	Description	Body
`200`	Booking status	`RessivoBooking`

Example

curl -X GET 'https://ressivo.com/api/ressivo/public/{slug}/bookings/{id}' \
  -H 'apikey: YOUR_API_KEY'

post`/ressivo/public/{slug}/bookings/{id}/cancel`

Cancel an unpaid booking and release its slots

Parameters

Name	In	Type	Required
`slug`	path	`string`	yes
`id`	path	`number`	yes

Responses

Status	Description	Body
`200`	Booking cancelled	`{ id, status }`

Example

curl -X POST 'https://ressivo.com/api/ressivo/public/{slug}/bookings/{id}/cancel' \
  -H 'apikey: YOUR_API_KEY'

get`/ressivo/public/{slug}/items`

List public listing items

Parameters

Name	In	Type	Required
`slug`	path	`string`	yes

Responses

Status	Description	Body
`200`	List of items	`RessivoItem[]`

Example

curl -X GET 'https://ressivo.com/api/ressivo/public/{slug}/items' \
  -H 'apikey: YOUR_API_KEY'

get`/ressivo/public/{slug}/settings`

Get public settings

Parameters

Name	In	Type	Required
`slug`	path	`string`	yes

Responses

Status	Description	Body
`200`	Public settings	`RessivoSettings`

Example

curl -X GET 'https://ressivo.com/api/ressivo/public/{slug}/settings' \
  -H 'apikey: YOUR_API_KEY'

Reports

get`/ressivo/reports`

Booking statistics for a listing and date range

Parameters

Name	In	Type	Required
`listingId`	query	`number`	yes
`dateFrom`	query	`string`	yes
`dateTo`	query	`string`	yes

Responses

Status	Description	Body
`200`	Aggregated booking statistics	`{ dateFrom, dateTo, availableSlots, occupancy, totals, byItem, heatmap }`
`400`	Validation error	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/ressivo/reports' \
  -H 'apikey: YOUR_API_KEY'

Settings

get`/ressivo/settings`

Get Ressivo settings

Parameters

Name	In	Type	Required
`listingId`	query	`number`	yes

Responses

Status	Description	Body
`200`	Ressivo settings	`RessivoSettings`

Example

curl -X GET 'https://ressivo.com/api/ressivo/settings' \
  -H 'apikey: YOUR_API_KEY'

put`/ressivo/settings/branding`

Update branding settings

Request body

application/json — ResissvoBrandingInput
multipart/form-data — { listingId, tagline, primaryColor, secondaryColor, heroImage, brandingHtml, file }

Responses

Status	Description	Body
`200`	Updated settings	`RessivoSettings`

Example

curl -X PUT 'https://ressivo.com/api/ressivo/settings/branding' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/ressivo/settings/business`

Update business details

Request body

application/json — RessivoBusinessInput

Responses

Status	Description	Body
`200`	Updated settings	`RessivoSettings`

Example

curl -X PUT 'https://ressivo.com/api/ressivo/settings/business' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

post`/ressivo/settings/calendar-token`

Regenerate the listing's calendar feed token

Request body

application/json — { listingId }

Responses

Status	Description	Body
`200`	New calendar token	`{ calendarToken }`

Example

curl -X POST 'https://ressivo.com/api/ressivo/settings/calendar-token' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/ressivo/settings/payment`

Update payment settings

Request body

application/json — RessivoPaymentInput

Responses

Status	Description	Body
`200`	Updated settings	`RessivoSettings`

Example

curl -X PUT 'https://ressivo.com/api/ressivo/settings/payment' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/ressivo/settings/policies`

Update policy settings

Request body

application/json — ResissvoPolicyInput

Responses

Status	Description	Body
`200`	Updated settings	`RessivoSettings`

Example

curl -X PUT 'https://ressivo.com/api/ressivo/settings/policies' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

Stripe connect

post`/ressivo/stripe-connect/create-account`

Create a Stripe Connect account for a listing

Request body

application/json — { listingId, email }

Responses

Status	Description	Body
`201`	Connected account created	`{ accountId }`

Example

curl -X POST 'https://ressivo.com/api/ressivo/stripe-connect/create-account' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

post`/ressivo/stripe-connect/onboarding-link`

Create an onboarding link for Stripe Connect

Request body

application/json — { listingId }

Responses

Status	Description	Body
`200`	Onboarding link	`{ url, expiresAt }`

Example

curl -X POST 'https://ressivo.com/api/ressivo/stripe-connect/onboarding-link' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

get`/ressivo/stripe-connect/status`

Get Stripe Connect account status for a listing

Parameters

Name	In	Type	Required
`listingId`	query	`number`	yes

Responses

Status	Description	Body
`200`	Stripe Connect status	`{ connected, accountId, chargesEnabled, detailsSubmitted }`

Example

curl -X GET 'https://ressivo.com/api/ressivo/stripe-connect/status' \
  -H 'apikey: YOUR_API_KEY'

Account and platform

Auth

post`/auth`

Authenticate

Request body

application/json — object

Responses

Status	Description	Body
`204`	Success.
`default`	Error	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/auth' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

post`/auth/logout`

Logout

Responses

Status	Description	Body
`204`	Success.

Example

curl -X POST 'https://ressivo.com/api/auth/logout' \
  -H 'apikey: YOUR_API_KEY'

put`/auth/password`

Change Password

Request body

application/json — { password, newpassword }

Responses

Status	Description	Body
`204`	Success.
`default`	Error	`{ statusCode, code, message }`

Example

curl -X PUT 'https://ressivo.com/api/auth/password' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

post`/auth/recover`

Request password recovery

Request body

application/json — PasswordRecoverRequest

Responses

Status	Description	Body
`204`	Success.
`default`	Error	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/auth/recover' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

post`/auth/recover/confirm`

Confirm password recovery

Request body

application/json — PasswordRecoverConfirm

Responses

Status	Description	Body
`204`	Success.
`default`	Error	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/auth/recover/confirm' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

get`/auth/user`

Authentication

Responses

Status	Description	Body
`200`	Auth data	`{ id, name, type, organizations, organizationId, apps }`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/auth/user' \
  -H 'apikey: YOUR_API_KEY'

Generic

get`/generic/countries`

Get countries

Responses

Status	Description	Body
`200`	Countries information list.	`Country[]`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/generic/countries' \
  -H 'apikey: YOUR_API_KEY'

Organizations

get`/organizations`

Get organization

Responses

Status	Description	Body
`200`	Organization information.	`Organization`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/organizations' \
  -H 'apikey: YOUR_API_KEY'

post`/organizations`

Create organization

Request body

application/json — { name, taxNumber, email, password, address, key, app }

Responses

Status	Description	Body
`201`	Organization information.	`Organization`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/organizations' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/organizations`

Update organization

Request body

application/json — { id, name, taxNumber, email, address }

Responses

Status	Description	Body
`200`	Organization information.	`Organization`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X PUT 'https://ressivo.com/api/organizations' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

get`/organizations/all`

Get all organizations (superadmin only)

Parameters

Name	In	Type	Required
`search`	query	`string`	no
`limit`	query	`integer`	no

Responses

Status	Description	Body
`200`	Organization list	`{ id, name, email, taxNumber }[]`

Example

curl -X GET 'https://ressivo.com/api/organizations/all' \
  -H 'apikey: YOUR_API_KEY'

get`/organizations/configuration`

Get organization configuration

Responses

Status	Description	Body
`200`	Organization configuration.	`{ organizationId, atUsername, atPassword }`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/organizations/configuration' \
  -H 'apikey: YOUR_API_KEY'

put`/organizations/configuration`

Update organization configuration

Request body

application/json — { atUsername, atPassword }

Responses

Status	Description	Body
`200`	Organization configuration.	`{ organizationId, atUsername, atPassword }`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X PUT 'https://ressivo.com/api/organizations/configuration' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/organizations/logo`

Update organization logo

Request body

multipart/form-data — { file }

Responses

Status	Description	Body
`200`	Organization information.	`Organization`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X PUT 'https://ressivo.com/api/organizations/logo' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

delete`/organizations/{id}`

Delete organization

Parameters

Name	In	Type	Required
`id`	path	`number`	yes

Responses

Status	Description	Body
`204`	Success.
`default`	Error	`{ statusCode, code, message }`

Example

curl -X DELETE 'https://ressivo.com/api/organizations/{id}' \
  -H 'apikey: YOUR_API_KEY'

Subscriptions

post`/subscriptions`

Create subscription

Request body

application/json — { app, name }

Responses

Status	Description	Body
`201`	Subscription information.	`{ id, paymentStripeId, paymentURL }`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/subscriptions' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

get`/subscriptions/app-plans`

Get active app plans for organizations

Parameters

Name	In	Type	Required
`app`	query	`string`	yes

Responses

Status	Description	Body
`200`	List of active plans for the app	`Plan[]`
`default`	Error

Example

curl -X GET 'https://ressivo.com/api/subscriptions/app-plans' \
  -H 'apikey: YOUR_API_KEY'

post`/subscriptions/organization/{id}/cancel`

Cancel organization subscription at period end

Parameters

Name	In	Type	Required
`id`	path	`integer`	yes

Responses

Status	Description	Body
`204`	Subscription cancellation scheduled

Example

curl -X POST 'https://ressivo.com/api/subscriptions/organization/{id}/cancel' \
  -H 'apikey: YOUR_API_KEY'

post`/subscriptions/organization/{id}/change-plan`

Change organization subscription plan

Parameters

Name	In	Type	Required
`id`	path	`integer`	yes

Request body

application/json — { planId }

Responses

Status	Description	Body
`204`	Subscription updated

Example

curl -X POST 'https://ressivo.com/api/subscriptions/organization/{id}/change-plan' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

post`/subscriptions/organization/{id}/resume`

Resume organization subscription cancellation

Parameters

Name	In	Type	Required
`id`	path	`integer`	yes

Responses

Status	Description	Body
`204`	Subscription resumed

Example

curl -X POST 'https://ressivo.com/api/subscriptions/organization/{id}/resume' \
  -H 'apikey: YOUR_API_KEY'

get`/subscriptions/public/app-plans`

Get public app plans

Parameters

Name	In	Type	Required
`app`	query	`string`	yes

Responses

Status	Description	Body
`200`	List of active plans for the app	`Plan[]`
`default`	Error

Example

curl -X GET 'https://ressivo.com/api/subscriptions/public/app-plans' \
  -H 'apikey: YOUR_API_KEY'

get`/subscriptions/{app}`

Get subscription

Parameters

Name	In	Type	Required
`app`	path	`string`	yes

Responses

Status	Description	Body
`200`	Subscription meta information.	`Subscription`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/subscriptions/{app}' \
  -H 'apikey: YOUR_API_KEY'

Users

get`/users`

Get users

Responses

Status	Description	Body
`200`	User information.	`User[]`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/users' \
  -H 'apikey: YOUR_API_KEY'

post`/users`

Create user

Request body

application/json — { name, username, password }

Responses

Status	Description	Body
`201`	User information.	`User`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/users' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/users`

Update user

Request body

application/json — { id, name, username, password }

Responses

Status	Description	Body
`200`	User information.	`User`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X PUT 'https://ressivo.com/api/users' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

get`/users/apikeys`

Get user api keys

Responses

Status	Description	Body
`200`	The keys of the app the caller is authenticated for. A key belongs to one app and the other apps never see it.	`APIKey[]`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X GET 'https://ressivo.com/api/users/apikeys' \
  -H 'apikey: YOUR_API_KEY'

post`/users/apikeys`

Create user api key

Request body

application/json — { name, readOnly }

Responses

Status	Description	Body
`201`	User API Key information.	`APIKey`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X POST 'https://ressivo.com/api/users/apikeys' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

put`/users/apikeys`

Update user api key

Request body

application/json — { id, name }

Responses

Status	Description	Body
`200`	User API Key information.	`APIKey`
`default`	Error	`{ statusCode, code, message }`

Example

curl -X PUT 'https://ressivo.com/api/users/apikeys' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

delete`/users/apikeys/{id}`

Delete user api key

Parameters

Name	In	Type	Required
`id`	path	`number`	yes

Responses

Status	Description	Body
`204`	Success.
`default`	Error	`{ statusCode, code, message }`

Example

curl -X DELETE 'https://ressivo.com/api/users/apikeys/{id}' \
  -H 'apikey: YOUR_API_KEY'

delete`/users/{id}`

Delete user

Parameters

Name	In	Type	Required
`id`	path	`number`	yes

Responses

Status	Description	Body
`204`	Success.
`default`	Error	`{ statusCode, code, message }`

Example

curl -X DELETE 'https://ressivo.com/api/users/{id}' \
  -H 'apikey: YOUR_API_KEY'

Getting started

Base URL

Authentication

Errors

Model Context Protocol

Reference

Ressivo

Availability

get/ressivo/availability

Parameters

Responses

Example

post/ressivo/availability

Request body

Responses

Example

put/ressivo/availability

Request body

Responses

Example

get/ressivo/availability/exceptions

Parameters

Responses

Example

post/ressivo/availability/exceptions

Request body

Responses

Example

put/ressivo/availability/exceptions

Request body

Responses

Example

delete/ressivo/availability/id/{id}

Parameters

Responses

Example

Bookings

get/ressivo/bookings

Parameters

Responses

Example

post/ressivo/bookings

Request body

Responses

Example

put/ressivo/bookings

Request body

Responses

Example

get/ressivo/bookings/{id}

Parameters

Responses

Example

Items

get/ressivo/items

Parameters

Responses

Example

post/ressivo/items

Request body

Responses

Example

put/ressivo/items

Request body

Responses

Example

delete/ressivo/items/id/{id}

Parameters

Responses

Example

Listings

get/ressivo/listings

Responses

Example

post/ressivo/listings

Request body

Responses

Example

put/ressivo/listings

Request body

get`/ressivo/availability`

post`/ressivo/availability`

put`/ressivo/availability`

get`/ressivo/availability/exceptions`

post`/ressivo/availability/exceptions`

put`/ressivo/availability/exceptions`

delete`/ressivo/availability/id/{id}`

get`/ressivo/bookings`

post`/ressivo/bookings`

put`/ressivo/bookings`

get`/ressivo/bookings/{id}`

get`/ressivo/items`

post`/ressivo/items`

put`/ressivo/items`

delete`/ressivo/items/id/{id}`

get`/ressivo/listings`

post`/ressivo/listings`

put`/ressivo/listings`

put`/ressivo/listings/custom-domain`

post`/ressivo/listings/custom-domain/verify`

delete`/ressivo/listings/custom-domain/{id}`

delete`/ressivo/listings/id/{id}`

get`/ressivo/onboarding`

post`/ressivo/onboarding/seed`

delete`/ressivo/onboarding/seed`

post`/ressivo/onboarding/skip`

get`/ressivo/public/calendar/{token}.ics`

get`/ressivo/public/resolve-domain`

get`/ressivo/public/{slug}/availability`

get`/ressivo/public/{slug}/availability/exceptions`

get`/ressivo/public/{slug}/availability/slot-counts`

get`/ressivo/public/{slug}/availability/slot-occupancy`

post`/ressivo/public/{slug}/bookings`

get`/ressivo/public/{slug}/bookings/{id}`

post`/ressivo/public/{slug}/bookings/{id}/cancel`