Skip to main content
GET
/
api
/
v1
/
integration-definition
/
{provider}
Get integration definition
curl --request GET \
  --url https://api.example.com/api/v1/integration-definition/{provider} \
  --header 'x-calry-api-key: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Hostaway Integration",
  "provider": "HOSTAWAY",
  "fieldsToSync": {
    "listing": {
      "name": true,
      "type": true,
      "rooms": true,
      "rating": true,
      "address": true,
      "checkIn": false,
      "contact": false,
      "checkOut": false,
      "currency": true,
      "latitude": true,
      "pictures": false,
      "timeZone": false,
      "amenities": true,
      "longitude": true,
      "providerID": true,
      "startPrice": false,
      "description": true,
      "bedroomCount": false,
      "internalName": false,
      "maxOccupancy": false,
      "thumbnailUrl": false,
      "bathroomCount": false,
      "maximumNights": true,
      "minimumNights": true,
      "listingDetails": true,
      "parentPropertyID": false
    }
  },
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-02T00:00:00.000Z",
  "icon": "https://example.com/icons/hostaway.png",
  "partnerKey": {
    "headers": {
      "x-api-key": "YOUR_API_KEY"
    },
    "queryParams": {
      "client_id": "YOUR_CLIENT_ID"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://ota-docs.calry.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-calry-api-key
string
header
required

Path Parameters

​
provider
enum<string>
required

The integration provider

Available options:
BOOKINGSYNC,
CIIRUS,
GUESTY,
HOSTAWAY,
HOSTFULLY,
HOSTIFY,
INTERHOME,
LODGIFY,
OWNERREZ,
HOSTHUB,
UPLISTING,
BEDS24,
HOST_TOOLS,
HOSTFULLYSANDBOX,
HOSPITABLE,
TOKEET

Response

Integration definition retrieved successfully

​
id
string
required

Unique identifier for the integration definition

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
name
string
required

Name of the integration

Example:

"Hostaway Integration"

​
provider
enum<string>
required

The integration provider

Available options:
BOOKINGSYNC,
CIIRUS,
GUESTY,
HOSTAWAY,
HOSTFULLY,
HOSTIFY,
INTERHOME,
LODGIFY,
OWNERREZ,
HOSTHUB,
UPLISTING,
BEDS24,
HOST_TOOLS,
HOSTFULLYSANDBOX,
HOSPITABLE,
TOKEET
Example:

"HOSTAWAY"

​
fieldsToSync
object
required

Configuration for which fields to sync

Example:
{
  "listing": {
    "name": true,
    "type": true,
    "rooms": true,
    "rating": true,
    "address": true,
    "checkIn": false,
    "contact": false,
    "checkOut": false,
    "currency": true,
    "latitude": true,
    "pictures": false,
    "timeZone": false,
    "amenities": true,
    "longitude": true,
    "providerID": true,
    "startPrice": false,
    "description": true,
    "bedroomCount": false,
    "internalName": false,
    "maxOccupancy": false,
    "thumbnailUrl": false,
    "bathroomCount": false,
    "maximumNights": true,
    "minimumNights": true,
    "listingDetails": true,
    "parentPropertyID": false
  }
}
​
createdAt
string<date-time>
required

When the integration definition was created

Example:

"2025-01-01T00:00:00.000Z"

​
updatedAt
string<date-time>
required

When the integration definition was last updated

Example:

"2025-01-02T00:00:00.000Z"

​
icon
string

URL of the integration icon

Example:

"https://example.com/icons/hostaway.png"

​
partnerKey
object

Configuration for the integration partner key

Example:
{
  "headers": { "x-api-key": "YOUR_API_KEY" },
  "queryParams": { "client_id": "YOUR_CLIENT_ID" }
}