API Documentation (v1)

Download OpenAPI specification:Download

Tour24 Client Api (v1.0)

Authentication

The Tour24 Client API V1 implements the Token Based Authentication generated based on a Client Identifier and an Api Key which are passed in header to return jwt and refreshtoken.

Fetch the Token

Following is the url for client to fetch token:

curl -X POST https://api.tour24.io/auth/login 
    -H "clientId: client_id" 
    -H "x-api-key: x-api-key" 

On Success, client receives:

HTTP/1.1 200 OK 
Content-Type: application/json

{
    "jwt": "eyJ0eXAi...TcV3Q",
    "refreshtoken": "6d8cd1d...9f75",
}

On Failure, client receives:

HTTP/1.1 401 UnAuthorized 
Content-Type: application/json

{
    "Invalid Client/No Client Id found",
}

Refresh the Token

Following is the url for client to refresh token:

curl -X POST https://api.tour24.io/auth/refresh 
    -H "clientId: client_id" 
    -H "x-api-key: x-api-key"

On Success, client receives:

HTTP/1.1 200 OK 
Content-Type: application/json

{
    "jwt": "eyJ0eXAi...TcV3Q",
    "refreshtoken": "6d8cd1d...9f75",
}

On Failure, client receives:

HTTP/1.1 401 UnAuthorized 
Content-Type: application/json

{
    "Invalid Client/No Client Id found",
}

Pagination:

pagination uses query parameters pagenumber and pagesize. Pagesize is restricted to a max of 50(even if the pagesize is greater than 50 only 50 records will be returned)

Following is the url for client to get guestcard list:

curl -X GET https://api.tour24.io/GuestCard/7b22b077-c445-448a-a849-78ee50d1a1e3/1(pagenumber)/20(pagesize) 
    -H "Authorization: Bearer access_token" 
    -H "clientId: client_Id"  
    -H "x-api-key: x-api-key" 

Appointments

TimeSlots

Authorizations:
Bearer
path Parameters
propertyid
required
string <uuid>

PropertyId

date
required
string <date-time>

Date

header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

TimeSlots

Authorizations:
Bearer
path Parameters
propertyid
required
string <uuid>

PropertyId

date
required
string <date-time>

Date

header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
{
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "date": "2019-08-24T14:15:22Z",
  • "availableAppointments": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "type": "string"
}

Available Days

Authorizations:
Bearer
path Parameters
propertyid
required
string <uuid>

PropertyId

fromDate
required
string <date-time>

From Date

toDate
required
string <date-time>

To Date

header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Auth

Fetch new token.

Sample request: Header : clientId: client_secret

POST api/Auth/Login
Authorizations:
Bearer
header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
{
  • "jwt": "string",
  • "refreshToken": "string"
}

Refresh Token

Sample request:

POST api/Auth/Refresh
{        
  "refreshToken": ""       
}
Authorizations:
Bearer
header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Request Body schema:
refreshToken
string or null

Responses

Request samples

Content type
{
  • "refreshToken": "string"
}

Response samples

Content type
application/json
{
  • "jwt": "string",
  • "refreshToken": "string"
}

GuestCard

Guestcard List

Authorizations:
Bearer
path Parameters
propertyid
required
string <uuid>

PropertyId

query Parameters
pagenumber
integer <int32>

PageNumber

pagesize
integer <int32>

PageSize

header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 0,
  • "pageSize": 0,
  • "firstPage": "http://example.com",
  • "lastPage": "http://example.com",
  • "totalPages": 0,
  • "totalRecords": 0,
  • "nextPage": "http://example.com",
  • "previousPage": "http://example.com",
  • "data": [
    ],
  • "succeeded": true,
  • "errors": [
    ],
  • "message": "string"
}

Guestcard Details.

Authorizations:
Bearer
path Parameters
propertyid
required
string <uuid>

PropertyId

guestcarduuid
required
string <uuid>

GuestCardId

header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "phone": "string",
  • "email": "string",
  • "moveInDate": "2019-08-24T14:15:22Z",
  • "unitType": "string",
  • "contactPreference": "string",
  • "leaseLength": 0,
  • "pets": true,
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "idVerified": true,
  • "ccVerified": true
}

Property

Property List.

Authorizations:
Bearer
header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Property Details.

Authorizations:
Bearer
path Parameters
propertyid
required
string <uuid>

PropertyId

header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "unitTypes": [
    ],
  • "tour24ToursAvailable": true,
  • "virtualToursAvailable": true,
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "idVerificationType": "0 - None",
  • "defaultForwardedSource": "string",
  • "salesforcePropertyId": "string",
  • "integrations": {
    },
  • "slug": "string",
  • "name": "string",
  • "propertyImage": "string",
  • "contactEmail": "string",
  • "contactPhone": "string",
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "streetAddress": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "companyId": 0,
  • "propertyConfiguration": {
    },
  • "petPolicy": "string",
  • "requestDesiredLeaseLength": true,
  • "requestPetInformation": true,
  • "requestCreditCard": true,
  • "timeZoneId": "string",
  • "leasingUrl": "string",
  • "goLiveDate": "2019-08-24T14:15:22Z",
  • "startDay": "0 - Sunday",
  • "termsLink": "string",
  • "mapLink": "string",
  • "prospectMessagesSuppressions": "0 - None",
  • "sendNoShowMessagesToProperty": true,
  • "hideFromSearches": true,
  • "tourPageImageURL": "string",
  • "propertyIntegrations": [
    ],
  • "propertyUnits": [
    ],
  • "enableUnitManagement": true,
  • "syncLeaseStatus": true,
  • "updateAvailableToTour": true,
  • "syncPropertyUnitsAvailability": true,
  • "leadForwardingId": 0,
  • "unitManagementId": 0,
  • "leadForwardingTypes": [
    ],
  • "unitManagementTypes": [
    ],
  • "beaconUuid": "string",
  • "maxTourScheduleCountsPerDay": 0
}

Schedule

Create GuestCard

Authorizations:
Bearer
path Parameters
propertyId
required
string <uuid>
header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Request Body schema:
firstName
string or null
lastName
string or null
email
string or null
phoneNumber
string or null
object (ProspectUserPreferenceDto)
source
string or null
sourceType
integer <int32> (SourceType)
Enum: "0 - None" "1 - Snippet" "2 - Knock" "3 - BetterBot" "4 - Hyly" "5 - Funnel"
unitTypeId
integer <int32>
sessionId
string or null

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "preferences": {
    },
  • "source": "string",
  • "sourceType": "0 - None",
  • "unitTypeId": 0,
  • "sessionId": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "event": {
    },
  • "utcEvent": {
    },
  • "postTourDowntime": 0
}

Reservation Detail

Authorizations:
Bearer
path Parameters
propertyid
required
string <uuid>
guestCardGuid
required
string <uuid>
header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "event": {
    },
  • "utcEvent": {
    },
  • "postTourDowntime": 0
}

Create Reservation

Authorizations:
Bearer
path Parameters
guestCardGuid
required
string <uuid>
query Parameters
propertyid
string <uuid>
header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Request Body schema:
startDateTime
string or null
endDateTime
string or null

Responses

Request samples

Content type
{
  • "startDateTime": "string",
  • "endDateTime": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "event": {
    },
  • "utcEvent": {
    },
  • "postTourDowntime": 0
}

Schedule Tour

Authorizations:
Bearer
path Parameters
propertyId
required
string <uuid>
guestCardGuid
required
string <uuid>
header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "event": {
    },
  • "utcEvent": {
    },
  • "postTourDowntime": 0
}

Tour

Tour List.

Authorizations:
Bearer
path Parameters
propertyid
required
string <uuid>

Property Id

query Parameters
pagenumber
integer <int32>

Page Number

pagesize
integer <int32>

Page Size

header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 0,
  • "pageSize": 0,
  • "firstPage": "http://example.com",
  • "lastPage": "http://example.com",
  • "totalPages": 0,
  • "totalRecords": 0,
  • "nextPage": "http://example.com",
  • "previousPage": "http://example.com",
  • "data": [
    ],
  • "succeeded": true,
  • "errors": [
    ],
  • "message": "string"
}

Tour Details.

Authorizations:
Bearer
path Parameters
propertyid
required
string <uuid>

Property Id

touruuid
required
string <uuid>

Tour Id

header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "status": "0 - Scheduled",
  • "propertyId": "8e8b8450-dc1b-4360-8109-7067337b42cb",
  • "guestcard": {
    }
}

Delete Tour

Authorizations:
Bearer
path Parameters
tourGuid
required
string <uuid>
header Parameters
clientId
required
string

Client Identifier

x-api-key
required
string

Api Key

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}