- Version: 1
- Host: connect.vacasa.com
Welcome to Vacasa Connect! Connect is a RESTful JSON API interface for Vacasa services.
Follow this link. In the upper-right-hand corner, click the latest released version. Then click the “Code” tab.
How can I use Connect?
Having Trouble? Check your Content-Type header.
All requests should include a Content-Type: application/vnd.api+json header.
How do I give feedback or get support?
Please speak to your supervisor or product representative.
Looking for a version of the docs prior to v1.51.0?
See Legacy Docs.
JSON-API + OpenAPI
This API adheres to the JSON-API 1.0 spec.
Some conventions are not covered in the JSON-API spec. See sections below for further convention guides.
Errors follow JSON-API spec: http://jsonapi.org/format/#errors
Validation errors can be found in the error response JSON body
The Connect API supports API token-based authentication.
Two endpoints are available to assist in managing your authenticated sessions:
- Create Authenticated Session
- Refresh Authenticated Session
To begin using Connect, you will need an API Secret and API Key. Speak to your product representative to obtain your secret and key.
Localization HTTP headers MAY be sent with each request to define the preferred language and country, timezone, or currency of response data.
The request MAY be honored. If the content cannot be delivered as requested in the localization headers, an error response is returned.
See Localization Trait for request header definitions.
Response content localization is expressed in the following HTTP headers:
Format will follow the same supported format as for the corresponding request headers.
Filtering follows recommendation defined at http://jsonapi.org/recommendations/#filtering.
Pagination follows specification defined at http://jsonapi.org/format/#fetching-pagination
?page[number]=1&page[size]=5 will result in returning page 1 with 5 results
Sorting follows this recommendation: http://jsonapi.org/format/#fetching-sorting
?sort=col1,-col2 will sort results first by
col1 (ascending) then
Sparse fieldsets are supported on non-authentication endpoints. http://jsonapi.org/format/#fetching-sparse-fieldsets
?fields[Reservation]=reservation_id,channel will retrieve only the
channel properties of
Reservation resource objects.
Sparse fieldsets may also be applied to included resource objects.
Only top-level object resource attributes can be specified.