AlphaAlpha Docs
API Reference

Booking Widget Config

API for managing booking widget configurations

Create a booking widget config

POST
/crm/booking/widgets

Authorization

AuthorizationBearer <token>

In: header

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/crm/booking/widgets" \  -H "Content-Type: application/json" \  -d '{    "bufferAfter": 0,    "bufferBefore": 0,    "defaultDuration": 0,    "durationOptions": [      0    ],    "eventCategory": "DEFAULT",    "eventTitle": "string",    "isActive": true,    "isLocationDependent": true,    "maxAdvanceDays": 0,    "minNoticeHours": 0,    "name": "string",    "slug": "string",    "teamMemberIds": [      "string"    ],    "teamName": "string"  }'
{
  "active": true,
  "assignedTeamLeadId": "string",
  "bufferAfter": 0,
  "bufferBefore": 0,
  "confirmationMessage": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultDuration": 0,
  "description": "string",
  "durationOptions": [
    0
  ],
  "eventCategory": "DEFAULT",
  "eventTitle": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isActive": true,
  "isLocationDependent": true,
  "locationDependent": true,
  "maxAdvanceDays": 0,
  "minNoticeHours": 0,
  "name": "string",
  "roundRobinCounter": 0,
  "slug": "string",
  "teamMemberIds": [
    "string"
  ],
  "teamName": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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 all active booking widget configs

GET
/crm/booking/widgets/active

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/booking/widgets/active"
[
  {
    "active": true,
    "assignedTeamLeadId": "string",
    "bufferAfter": 0,
    "bufferBefore": 0,
    "confirmationMessage": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "defaultDuration": 0,
    "description": "string",
    "durationOptions": [
      0
    ],
    "eventCategory": "DEFAULT",
    "eventTitle": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isActive": true,
    "isLocationDependent": true,
    "locationDependent": true,
    "maxAdvanceDays": 0,
    "minNoticeHours": 0,
    "name": "string",
    "roundRobinCounter": 0,
    "slug": "string",
    "teamMemberIds": [
      "string"
    ],
    "teamName": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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"
}

Download Csv_ Booking Widget Config

GET
/crm/booking/widgets/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/booking/widgets/csv-export"
"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"
}

Delete a list of entities by their IDs

DELETE
/crm/booking/widgets/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/crm/booking/widgets/delete-list?ids=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"
}

Dynamic Search_ Booking Widget Config

GET
/crm/booking/widgets/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/booking/widgets/dynamic-search"
{
  "content": [
    {
      "active": true,
      "assignedTeamLeadId": "string",
      "bufferAfter": 0,
      "bufferBefore": 0,
      "confirmationMessage": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "defaultDuration": 0,
      "description": "string",
      "durationOptions": [
        0
      ],
      "eventCategory": "DEFAULT",
      "eventTitle": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isActive": true,
      "isLocationDependent": true,
      "locationDependent": true,
      "maxAdvanceDays": 0,
      "minNoticeHours": 0,
      "name": "string",
      "roundRobinCounter": 0,
      "slug": "string",
      "teamMemberIds": [
        "string"
      ],
      "teamName": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Dynamic Search Post_ Booking Widget Config

POST
/crm/booking/widgets/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

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/crm/booking/widgets/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "active": true,
      "assignedTeamLeadId": "string",
      "bufferAfter": 0,
      "bufferBefore": 0,
      "confirmationMessage": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "defaultDuration": 0,
      "description": "string",
      "durationOptions": [
        0
      ],
      "eventCategory": "DEFAULT",
      "eventTitle": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isActive": true,
      "isLocationDependent": true,
      "locationDependent": true,
      "maxAdvanceDays": 0,
      "minNoticeHours": 0,
      "name": "string",
      "roundRobinCounter": 0,
      "slug": "string",
      "teamMemberIds": [
        "string"
      ],
      "teamName": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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"
}

Find by list of ids in current tenant

GET
/crm/booking/widgets/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/booking/widgets/find?ids=string"
[
  {
    "active": true,
    "assignedTeamLeadId": "string",
    "bufferAfter": 0,
    "bufferBefore": 0,
    "confirmationMessage": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "defaultDuration": 0,
    "description": "string",
    "durationOptions": [
      0
    ],
    "eventCategory": "DEFAULT",
    "eventTitle": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isActive": true,
    "isLocationDependent": true,
    "locationDependent": true,
    "maxAdvanceDays": 0,
    "minNoticeHours": 0,
    "name": "string",
    "roundRobinCounter": 0,
    "slug": "string",
    "teamMemberIds": [
      "string"
    ],
    "teamName": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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"
}

Find all for current tenant

GET
/crm/booking/widgets/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/booking/widgets/find-all"
[
  {
    "active": true,
    "assignedTeamLeadId": "string",
    "bufferAfter": 0,
    "bufferBefore": 0,
    "confirmationMessage": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "defaultDuration": 0,
    "description": "string",
    "durationOptions": [
      0
    ],
    "eventCategory": "DEFAULT",
    "eventTitle": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isActive": true,
    "isLocationDependent": true,
    "locationDependent": true,
    "maxAdvanceDays": 0,
    "minNoticeHours": 0,
    "name": "string",
    "roundRobinCounter": 0,
    "slug": "string",
    "teamMemberIds": [
      "string"
    ],
    "teamName": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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"
}

Find a list of entities by their IDs

GET
/crm/booking/widgets/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/booking/widgets/find-list"
[
  {
    "active": true,
    "assignedTeamLeadId": "string",
    "bufferAfter": 0,
    "bufferBefore": 0,
    "confirmationMessage": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "defaultDuration": 0,
    "description": "string",
    "durationOptions": [
      0
    ],
    "eventCategory": "DEFAULT",
    "eventTitle": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "isActive": true,
    "isLocationDependent": true,
    "locationDependent": true,
    "maxAdvanceDays": 0,
    "minNoticeHours": 0,
    "name": "string",
    "roundRobinCounter": 0,
    "slug": "string",
    "teamMemberIds": [
      "string"
    ],
    "teamName": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "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"
}

Find by id in current tenant

GET
/crm/booking/widgets/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/booking/widgets/find/string"
{
  "active": true,
  "assignedTeamLeadId": "string",
  "bufferAfter": 0,
  "bufferBefore": 0,
  "confirmationMessage": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultDuration": 0,
  "description": "string",
  "durationOptions": [
    0
  ],
  "eventCategory": "DEFAULT",
  "eventTitle": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isActive": true,
  "isLocationDependent": true,
  "locationDependent": true,
  "maxAdvanceDays": 0,
  "minNoticeHours": 0,
  "name": "string",
  "roundRobinCounter": 0,
  "slug": "string",
  "teamMemberIds": [
    "string"
  ],
  "teamName": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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 page by page number and size with optional sorting based on field to sortBy and direction

GET
/crm/booking/widgets/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/booking/widgets/page"
{
  "content": [
    {
      "active": true,
      "assignedTeamLeadId": "string",
      "bufferAfter": 0,
      "bufferBefore": 0,
      "confirmationMessage": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "defaultDuration": 0,
      "description": "string",
      "durationOptions": [
        0
      ],
      "eventCategory": "DEFAULT",
      "eventTitle": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "isActive": true,
      "isLocationDependent": true,
      "locationDependent": true,
      "maxAdvanceDays": 0,
      "minNoticeHours": 0,
      "name": "string",
      "roundRobinCounter": 0,
      "slug": "string",
      "teamMemberIds": [
        "string"
      ],
      "teamName": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "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 a booking widget config

GET
/crm/booking/widgets/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/booking/widgets/string"
{
  "active": true,
  "assignedTeamLeadId": "string",
  "bufferAfter": 0,
  "bufferBefore": 0,
  "confirmationMessage": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultDuration": 0,
  "description": "string",
  "durationOptions": [
    0
  ],
  "eventCategory": "DEFAULT",
  "eventTitle": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isActive": true,
  "isLocationDependent": true,
  "locationDependent": true,
  "maxAdvanceDays": 0,
  "minNoticeHours": 0,
  "name": "string",
  "roundRobinCounter": 0,
  "slug": "string",
  "teamMemberIds": [
    "string"
  ],
  "teamName": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Update a booking widget config

PATCH
/crm/booking/widgets/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*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 PATCH "http://localhost:18080/api/v1/crm/booking/widgets/string" \  -H "Content-Type: application/json" \  -d '{    "bufferAfter": 0,    "bufferBefore": 0,    "defaultDuration": 0,    "durationOptions": [      0    ],    "eventCategory": "DEFAULT",    "eventTitle": "string",    "isActive": true,    "isLocationDependent": true,    "maxAdvanceDays": 0,    "minNoticeHours": 0,    "name": "string",    "slug": "string",    "teamMemberIds": [      "string"    ],    "teamName": "string"  }'
{
  "active": true,
  "assignedTeamLeadId": "string",
  "bufferAfter": 0,
  "bufferBefore": 0,
  "confirmationMessage": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "defaultDuration": 0,
  "description": "string",
  "durationOptions": [
    0
  ],
  "eventCategory": "DEFAULT",
  "eventTitle": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "isActive": true,
  "isLocationDependent": true,
  "locationDependent": true,
  "maxAdvanceDays": 0,
  "minNoticeHours": 0,
  "name": "string",
  "roundRobinCounter": 0,
  "slug": "string",
  "teamMemberIds": [
    "string"
  ],
  "teamName": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "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"
}

Delete by id in current tenant

DELETE
/crm/booking/widgets/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/crm/booking/widgets/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"
}

Add a comment to an entity

POST
/crm/booking/widgets/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/crm/booking/widgets/string/comment" \  -H "Content-Type: application/json" \  -d '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"
}

Blob storage

Previous Page

Bookings

Next Page