Skip to main content
GET
/
api
/
v1
/
oauth-app
/
{provider}
Get OAuth App by Provider
curl --request GET \
  --url https://api.example.com/api/v1/oauth-app/{provider} \
  --header 'x-calry-api-key: <api-key>'
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "provider": "HOSTFULLY",
  "client_id": "XXXXXXXXXX",
  "scopes": "read_listings write_listings read_bookings",
  "status": "ACTIVE",
  "createdAt": "2024-03-20T10:00:00.000Z",
  "updatedAt": "2024-03-20T10:00:00.000Z"
}

Authorizations

​
x-calry-api-key
string
header
required

Path Parameters

​
provider
enum<string>
required

Integration provider for the OAuth app

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

Response

OAuth app retrieved successfully

​
id
string
required

Unique identifier of the OAuth application

Example:

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

​
provider
enum<string>
required

Integration provider for the OAuth application

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

"HOSTFULLY"

​
client_id
string
required

Provider Client ID for the OAuth Application. Refer to the provider documentation for more information.

Example:

"XXXXXXXXXX"

​
scopes
string
required

OAuth scopes required for the application. Refer to the provider documentation for more information.

Example:

"read_listings write_listings read_bookings"

​
status
enum<string>
required

Status of the OAuth application

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

​
createdAt
string<date-time>
required

Timestamp when the OAuth application was created

Example:

"2024-03-20T10:00:00.000Z"

​
updatedAt
string<date-time>
required

Timestamp when the OAuth application was last updated

Example:

"2024-03-20T10:00:00.000Z"