AlphaAlpha Docs

Public Booking

Public endpoints for appointment booking

Get widget info

GET
/public/booking/{tenantCode}/{widgetSlug}
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string
widgetSlug*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/public/booking/string/string"
{
  "defaultDuration": 0,
  "description": "string",
  "durationOptions": [
    0
  ],
  "eventCategory": "DEFAULT",
  "isLocationDependent": true,
  "maxAdvanceDays": 0,
  "name": "string",
  "teamName": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get available dates

POST
/public/booking/{tenantCode}/{widgetSlug}/available-dates
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string
widgetSlug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/public/booking/string/string/available-dates" \  -H "Content-Type: application/json" \  -d '{    "duration": 0,    "from": "2019-08-24",    "timezone": "string",    "to": "2019-08-24"  }'
{
  "availableDates": [
    "2019-08-24"
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Create a booking

POST
/public/booking/{tenantCode}/{widgetSlug}/book
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string
widgetSlug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/public/booking/string/string/book" \  -H "Content-Type: application/json" \  -d '{    "duration": 0,    "email": "string",    "firstName": "string",    "lastName": "string",    "startTime": "2019-08-24T14:15:22Z",    "timezone": "string"  }'
{
  "assignedTo": "string",
  "bookingId": "string",
  "cancellationToken": "string",
  "confirmationMessage": "string",
  "duration": 0,
  "endTime": "2019-08-24T14:15:22Z",
  "startTime": "2019-08-24T14:15:22Z"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Cancel a booking

POST
/public/booking/{tenantCode}/{widgetSlug}/cancel
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string
widgetSlug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

cancellationToken*string

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/public/booking/string/string/cancel" \  -H "Content-Type: application/json" \  -d '{    "cancellationToken": "string"  }'
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get available time slots

POST
/public/booking/{tenantCode}/{widgetSlug}/slots
AuthorizationBearer <token>

In: header

Path Parameters

tenantCode*string
widgetSlug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/public/booking/string/string/slots" \  -H "Content-Type: application/json" \  -d '{    "date": "2019-08-24",    "duration": 0,    "timezone": "string"  }'
{
  "date": "2019-08-24",
  "duration": 0,
  "slots": [
    {
      "availableCount": 0,
      "endTime": "2019-08-24T14:15:22Z",
      "startTime": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}