AlphaAlpha Docs
API Reference

Bookings

API for managing bookings

Get bookings by widget and date range

GET
/crm/bookings/by-widget/{widgetId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

widgetId*string

Query Parameters

start*string
Formatdate
end*string
Formatdate

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/bookings/by-widget/string?start=2019-08-24&end=2019-08-24"
[
  {
    "activityId": "string",
    "assignedEmployeeId": "string",
    "assignedSubsidiaryId": "string",
    "calendarEventId": "string",
    "cancellationToken": "string",
    "city": "string",
    "companyName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "duration": 0,
    "email": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "houseNumber": "string",
    "id": "string",
    "lastName": "string",
    "leadId": "string",
    "message": "string",
    "phone": "string",
    "postalCode": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "status": "CONFIRMED",
    "street": "string",
    "tenantId": "string",
    "timezone": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "widgetConfigId": "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

GET
/crm/bookings/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/bookings/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/bookings/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/bookings/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

GET
/crm/bookings/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/bookings/dynamic-search"
{
  "content": [
    {
      "activityId": "string",
      "assignedEmployeeId": "string",
      "assignedSubsidiaryId": "string",
      "calendarEventId": "string",
      "cancellationToken": "string",
      "city": "string",
      "companyName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "duration": 0,
      "email": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "firstName": "string",
      "houseNumber": "string",
      "id": "string",
      "lastName": "string",
      "leadId": "string",
      "message": "string",
      "phone": "string",
      "postalCode": "string",
      "startTime": "2019-08-24T14:15:22Z",
      "status": "CONFIRMED",
      "street": "string",
      "tenantId": "string",
      "timezone": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "widgetConfigId": "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

POST
/crm/bookings/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/bookings/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": [
    {
      "activityId": "string",
      "assignedEmployeeId": "string",
      "assignedSubsidiaryId": "string",
      "calendarEventId": "string",
      "cancellationToken": "string",
      "city": "string",
      "companyName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "duration": 0,
      "email": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "firstName": "string",
      "houseNumber": "string",
      "id": "string",
      "lastName": "string",
      "leadId": "string",
      "message": "string",
      "phone": "string",
      "postalCode": "string",
      "startTime": "2019-08-24T14:15:22Z",
      "status": "CONFIRMED",
      "street": "string",
      "tenantId": "string",
      "timezone": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "widgetConfigId": "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/bookings/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/bookings/find?ids=string"
[
  {
    "activityId": "string",
    "assignedEmployeeId": "string",
    "assignedSubsidiaryId": "string",
    "calendarEventId": "string",
    "cancellationToken": "string",
    "city": "string",
    "companyName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "duration": 0,
    "email": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "houseNumber": "string",
    "id": "string",
    "lastName": "string",
    "leadId": "string",
    "message": "string",
    "phone": "string",
    "postalCode": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "status": "CONFIRMED",
    "street": "string",
    "tenantId": "string",
    "timezone": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "widgetConfigId": "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/bookings/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/bookings/find-all"
[
  {
    "activityId": "string",
    "assignedEmployeeId": "string",
    "assignedSubsidiaryId": "string",
    "calendarEventId": "string",
    "cancellationToken": "string",
    "city": "string",
    "companyName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "duration": 0,
    "email": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "houseNumber": "string",
    "id": "string",
    "lastName": "string",
    "leadId": "string",
    "message": "string",
    "phone": "string",
    "postalCode": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "status": "CONFIRMED",
    "street": "string",
    "tenantId": "string",
    "timezone": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "widgetConfigId": "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/bookings/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/bookings/find-list"
[
  {
    "activityId": "string",
    "assignedEmployeeId": "string",
    "assignedSubsidiaryId": "string",
    "calendarEventId": "string",
    "cancellationToken": "string",
    "city": "string",
    "companyName": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "duration": 0,
    "email": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "firstName": "string",
    "houseNumber": "string",
    "id": "string",
    "lastName": "string",
    "leadId": "string",
    "message": "string",
    "phone": "string",
    "postalCode": "string",
    "startTime": "2019-08-24T14:15:22Z",
    "status": "CONFIRMED",
    "street": "string",
    "tenantId": "string",
    "timezone": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "widgetConfigId": "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/bookings/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/bookings/find/string"
{
  "activityId": "string",
  "assignedEmployeeId": "string",
  "assignedSubsidiaryId": "string",
  "calendarEventId": "string",
  "cancellationToken": "string",
  "city": "string",
  "companyName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "email": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "houseNumber": "string",
  "id": "string",
  "lastName": "string",
  "leadId": "string",
  "message": "string",
  "phone": "string",
  "postalCode": "string",
  "startTime": "2019-08-24T14:15:22Z",
  "status": "CONFIRMED",
  "street": "string",
  "tenantId": "string",
  "timezone": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "widgetConfigId": "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/bookings/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/bookings/page"
{
  "content": [
    {
      "activityId": "string",
      "assignedEmployeeId": "string",
      "assignedSubsidiaryId": "string",
      "calendarEventId": "string",
      "cancellationToken": "string",
      "city": "string",
      "companyName": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "duration": 0,
      "email": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "firstName": "string",
      "houseNumber": "string",
      "id": "string",
      "lastName": "string",
      "leadId": "string",
      "message": "string",
      "phone": "string",
      "postalCode": "string",
      "startTime": "2019-08-24T14:15:22Z",
      "status": "CONFIRMED",
      "street": "string",
      "tenantId": "string",
      "timezone": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "widgetConfigId": "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

GET
/crm/bookings/{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/bookings/string"
{
  "activityId": "string",
  "assignedEmployeeId": "string",
  "assignedSubsidiaryId": "string",
  "calendarEventId": "string",
  "cancellationToken": "string",
  "city": "string",
  "companyName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "email": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "houseNumber": "string",
  "id": "string",
  "lastName": "string",
  "leadId": "string",
  "message": "string",
  "phone": "string",
  "postalCode": "string",
  "startTime": "2019-08-24T14:15:22Z",
  "status": "CONFIRMED",
  "street": "string",
  "tenantId": "string",
  "timezone": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "widgetConfigId": "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/bookings/{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/bookings/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/bookings/{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/bookings/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"
}

Update booking status

PATCH
/crm/bookings/{id}/status

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

[key: string]?string

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "http://localhost:18080/api/v1/crm/bookings/string/status" \  -H "Content-Type: application/json" \  -d '{    "property1": "string",    "property2": "string"  }'
{
  "activityId": "string",
  "assignedEmployeeId": "string",
  "assignedSubsidiaryId": "string",
  "calendarEventId": "string",
  "cancellationToken": "string",
  "city": "string",
  "companyName": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "duration": 0,
  "email": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "firstName": "string",
  "houseNumber": "string",
  "id": "string",
  "lastName": "string",
  "leadId": "string",
  "message": "string",
  "phone": "string",
  "postalCode": "string",
  "startTime": "2019-08-24T14:15:22Z",
  "status": "CONFIRMED",
  "street": "string",
  "tenantId": "string",
  "timezone": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "widgetConfigId": "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"
}

Booking Widget Config

Previous Page

Brochure Widget Config

Next Page