Vacasa Connect
Powered by Stoplight

Vacasa Connect

  • Version: 1
  • Host: connect.vacasa.com
  • Protocols: https

Welcome to Vacasa Connect! Connect is a RESTful JSON API interface for Vacasa services.

Download Spec

Follow this link. In the upper-right-hand corner, click the latest released version. Then click the “Code” tab.

How can I use Connect?

You will need an HTTP client – either a library or an application – to interact with the API. Consider Paw (for Mac) or Postman.

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.

Our spec files conform to OpenAPI 2.0/Swagger specification. There are many libraries and clients available for OpenAPI, which should ease your integration efforts.

Some conventions are not covered in the JSON-API spec. See sections below for further convention guides.

Error Responses

Errors follow JSON-API spec: http://jsonapi.org/format/#errors

Validation errors can be found in the error response JSON body meta node.

Authentication

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

Requests

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.

Responses

Response content localization is expressed in the following HTTP headers:

  • Content-Language
  • X-Currency
  • X-Timezone

Format will follow the same supported format as for the corresponding request headers.

Filtering

Filtering follows recommendation defined at http://jsonapi.org/recommendations/#filtering.

Pagination

Pagination follows specification defined at http://jsonapi.org/format/#fetching-pagination

For example ?page[number]=1&page[size]=5 will result in returning page 1 with 5 results

Sorting

Sorting follows this recommendation: http://jsonapi.org/format/#fetching-sorting

For example ?sort=col1,-col2 will sort results first by col1 (ascending) then col2 (descending).

Sparse Fieldsets

Sparse fieldsets are supported on non-authentication endpoints. http://jsonapi.org/format/#fetching-sparse-fieldsets

Example

?fields[Reservation]=reservation_id,channel will retrieve only the reservation_id and 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.