AlphaAlpha Docs
API Reference

Calendar Events

API for calendar event management

Create a calendar event

POST
/crm/calendar/events

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/calendar/events" \  -H "Content-Type: application/json" \  -d '{    "allDay": true,    "attendees": [      {        "email": "string",        "status": "PENDING"      }    ],    "category": "DEFAULT",    "endTime": "2019-08-24T14:15:22Z",    "reminders": [      {        "minutesBefore": 0,        "type": "NOTIFICATION"      }    ],    "startTime": "2019-08-24T14:15:22Z",    "title": "string",    "visibility": "PRIVATE"  }'
{
  "allDay": true,
  "attendees": [
    {
      "email": "string",
      "name": "string",
      "status": "PENDING",
      "userId": "string"
    }
  ],
  "category": "DEFAULT",
  "color": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "googleEventId": "string",
  "id": "string",
  "lastSyncedAt": "2019-08-24T14:15:22Z",
  "lead": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string"
  },
  "leadId": "string",
  "location": "string",
  "onlineMeetingUrl": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "status": "string"
  },
  "opportunityId": "string",
  "outlookEventId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "reminders": [
    {
      "minutesBefore": 0,
      "type": "NOTIFICATION"
    }
  ],
  "startTime": "2019-08-24T14:15:22Z",
  "syncSource": "GOOGLE",
  "tenantId": "string",
  "title": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "visibility": "PRIVATE"
}
{
  "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 events by customer

GET
/crm/calendar/events/by-customer/{customerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

customerId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/events/by-customer/string"
[
  {
    "allDay": true,
    "attendees": [
      {
        "email": "string",
        "name": "string",
        "status": "PENDING",
        "userId": "string"
      }
    ],
    "category": "DEFAULT",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "externalCalendarId": "string",
    "googleEventId": "string",
    "id": "string",
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "leadId": "string",
    "location": "string",
    "onlineMeetingUrl": "string",
    "opportunityId": "string",
    "outlookEventId": "string",
    "ownerId": "string",
    "reminders": [
      {
        "minutesBefore": 0,
        "type": "NOTIFICATION"
      }
    ],
    "startTime": "2019-08-24T14:15:22Z",
    "syncSource": "GOOGLE",
    "tenantId": "string",
    "title": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "visibility": "PRIVATE"
  }
]
{
  "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 events by date range

GET
/crm/calendar/events/by-date-range

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

start*string
Formatdate-time
end*string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/events/by-date-range?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
[
  {
    "allDay": true,
    "attendees": [
      {
        "email": "string",
        "name": "string",
        "status": "PENDING",
        "userId": "string"
      }
    ],
    "category": "DEFAULT",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customer": {
      "email": "string",
      "id": "string",
      "name": "string",
      "phone": "string"
    },
    "customerId": "string",
    "description": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "googleEventId": "string",
    "id": "string",
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "lead": {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string"
    },
    "leadId": "string",
    "location": "string",
    "onlineMeetingUrl": "string",
    "opportunity": {
      "id": "string",
      "name": "string",
      "status": "string"
    },
    "opportunityId": "string",
    "outlookEventId": "string",
    "owner": {
      "displayName": "string",
      "id": "string",
      "username": "string"
    },
    "ownerId": "string",
    "reminders": [
      {
        "minutesBefore": 0,
        "type": "NOTIFICATION"
      }
    ],
    "startTime": "2019-08-24T14:15:22Z",
    "syncSource": "GOOGLE",
    "tenantId": "string",
    "title": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "visibility": "PRIVATE"
  }
]
{
  "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 events by date range for a specific owner

GET
/crm/calendar/events/by-date-range/{ownerId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

ownerId*string

Query Parameters

start*string
Formatdate-time
end*string
Formatdate-time

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/events/by-date-range/string?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
[
  {
    "allDay": true,
    "attendees": [
      {
        "email": "string",
        "name": "string",
        "status": "PENDING",
        "userId": "string"
      }
    ],
    "category": "DEFAULT",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customer": {
      "email": "string",
      "id": "string",
      "name": "string",
      "phone": "string"
    },
    "customerId": "string",
    "description": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "googleEventId": "string",
    "id": "string",
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "lead": {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string"
    },
    "leadId": "string",
    "location": "string",
    "onlineMeetingUrl": "string",
    "opportunity": {
      "id": "string",
      "name": "string",
      "status": "string"
    },
    "opportunityId": "string",
    "outlookEventId": "string",
    "owner": {
      "displayName": "string",
      "id": "string",
      "username": "string"
    },
    "ownerId": "string",
    "reminders": [
      {
        "minutesBefore": 0,
        "type": "NOTIFICATION"
      }
    ],
    "startTime": "2019-08-24T14:15:22Z",
    "syncSource": "GOOGLE",
    "tenantId": "string",
    "title": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "visibility": "PRIVATE"
  }
]
{
  "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 events by opportunity

GET
/crm/calendar/events/by-opportunity/{opportunityId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

opportunityId*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/events/by-opportunity/string"
[
  {
    "allDay": true,
    "attendees": [
      {
        "email": "string",
        "name": "string",
        "status": "PENDING",
        "userId": "string"
      }
    ],
    "category": "DEFAULT",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "externalCalendarId": "string",
    "googleEventId": "string",
    "id": "string",
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "leadId": "string",
    "location": "string",
    "onlineMeetingUrl": "string",
    "opportunityId": "string",
    "outlookEventId": "string",
    "ownerId": "string",
    "reminders": [
      {
        "minutesBefore": 0,
        "type": "NOTIFICATION"
      }
    ],
    "startTime": "2019-08-24T14:15:22Z",
    "syncSource": "GOOGLE",
    "tenantId": "string",
    "title": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "visibility": "PRIVATE"
  }
]
{
  "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_ Calendar Event

GET
/crm/calendar/events/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/calendar/events/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/calendar/events/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/calendar/events/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_ Calendar Event

GET
/crm/calendar/events/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/calendar/events/dynamic-search"
{
  "content": [
    {
      "allDay": true,
      "attendees": [
        {
          "email": "string",
          "name": "string",
          "status": "PENDING",
          "userId": "string"
        }
      ],
      "category": "DEFAULT",
      "color": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "externalCalendarId": "string",
      "googleEventId": "string",
      "id": "string",
      "lastSyncedAt": "2019-08-24T14:15:22Z",
      "leadId": "string",
      "location": "string",
      "onlineMeetingUrl": "string",
      "opportunityId": "string",
      "outlookEventId": "string",
      "ownerId": "string",
      "reminders": [
        {
          "minutesBefore": 0,
          "type": "NOTIFICATION"
        }
      ],
      "startTime": "2019-08-24T14:15:22Z",
      "syncSource": "GOOGLE",
      "tenantId": "string",
      "title": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "visibility": "PRIVATE"
    }
  ],
  "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_ Calendar Event

POST
/crm/calendar/events/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/calendar/events/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": [
    {
      "allDay": true,
      "attendees": [
        {
          "email": "string",
          "name": "string",
          "status": "PENDING",
          "userId": "string"
        }
      ],
      "category": "DEFAULT",
      "color": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "externalCalendarId": "string",
      "googleEventId": "string",
      "id": "string",
      "lastSyncedAt": "2019-08-24T14:15:22Z",
      "leadId": "string",
      "location": "string",
      "onlineMeetingUrl": "string",
      "opportunityId": "string",
      "outlookEventId": "string",
      "ownerId": "string",
      "reminders": [
        {
          "minutesBefore": 0,
          "type": "NOTIFICATION"
        }
      ],
      "startTime": "2019-08-24T14:15:22Z",
      "syncSource": "GOOGLE",
      "tenantId": "string",
      "title": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "visibility": "PRIVATE"
    }
  ],
  "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/calendar/events/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/calendar/events/find?ids=string"
[
  {
    "allDay": true,
    "attendees": [
      {
        "email": "string",
        "name": "string",
        "status": "PENDING",
        "userId": "string"
      }
    ],
    "category": "DEFAULT",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "externalCalendarId": "string",
    "googleEventId": "string",
    "id": "string",
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "leadId": "string",
    "location": "string",
    "onlineMeetingUrl": "string",
    "opportunityId": "string",
    "outlookEventId": "string",
    "ownerId": "string",
    "reminders": [
      {
        "minutesBefore": 0,
        "type": "NOTIFICATION"
      }
    ],
    "startTime": "2019-08-24T14:15:22Z",
    "syncSource": "GOOGLE",
    "tenantId": "string",
    "title": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "visibility": "PRIVATE"
  }
]
{
  "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/calendar/events/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/calendar/events/find-all"
[
  {
    "allDay": true,
    "attendees": [
      {
        "email": "string",
        "name": "string",
        "status": "PENDING",
        "userId": "string"
      }
    ],
    "category": "DEFAULT",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "externalCalendarId": "string",
    "googleEventId": "string",
    "id": "string",
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "leadId": "string",
    "location": "string",
    "onlineMeetingUrl": "string",
    "opportunityId": "string",
    "outlookEventId": "string",
    "ownerId": "string",
    "reminders": [
      {
        "minutesBefore": 0,
        "type": "NOTIFICATION"
      }
    ],
    "startTime": "2019-08-24T14:15:22Z",
    "syncSource": "GOOGLE",
    "tenantId": "string",
    "title": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "visibility": "PRIVATE"
  }
]
{
  "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/calendar/events/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/calendar/events/find-list"
[
  {
    "allDay": true,
    "attendees": [
      {
        "email": "string",
        "name": "string",
        "status": "PENDING",
        "userId": "string"
      }
    ],
    "category": "DEFAULT",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customerId": "string",
    "description": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "externalCalendarId": "string",
    "googleEventId": "string",
    "id": "string",
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "leadId": "string",
    "location": "string",
    "onlineMeetingUrl": "string",
    "opportunityId": "string",
    "outlookEventId": "string",
    "ownerId": "string",
    "reminders": [
      {
        "minutesBefore": 0,
        "type": "NOTIFICATION"
      }
    ],
    "startTime": "2019-08-24T14:15:22Z",
    "syncSource": "GOOGLE",
    "tenantId": "string",
    "title": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "visibility": "PRIVATE"
  }
]
{
  "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/calendar/events/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/calendar/events/find/string"
{
  "allDay": true,
  "attendees": [
    {
      "email": "string",
      "name": "string",
      "status": "PENDING",
      "userId": "string"
    }
  ],
  "category": "DEFAULT",
  "color": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customerId": "string",
  "description": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "externalCalendarId": "string",
  "googleEventId": "string",
  "id": "string",
  "lastSyncedAt": "2019-08-24T14:15:22Z",
  "leadId": "string",
  "location": "string",
  "onlineMeetingUrl": "string",
  "opportunityId": "string",
  "outlookEventId": "string",
  "ownerId": "string",
  "reminders": [
    {
      "minutesBefore": 0,
      "type": "NOTIFICATION"
    }
  ],
  "startTime": "2019-08-24T14:15:22Z",
  "syncSource": "GOOGLE",
  "tenantId": "string",
  "title": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "visibility": "PRIVATE"
}
{
  "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/calendar/events/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/calendar/events/page"
{
  "content": [
    {
      "allDay": true,
      "attendees": [
        {
          "email": "string",
          "name": "string",
          "status": "PENDING",
          "userId": "string"
        }
      ],
      "category": "DEFAULT",
      "color": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "customerId": "string",
      "description": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "externalCalendarId": "string",
      "googleEventId": "string",
      "id": "string",
      "lastSyncedAt": "2019-08-24T14:15:22Z",
      "leadId": "string",
      "location": "string",
      "onlineMeetingUrl": "string",
      "opportunityId": "string",
      "outlookEventId": "string",
      "ownerId": "string",
      "reminders": [
        {
          "minutesBefore": 0,
          "type": "NOTIFICATION"
        }
      ],
      "startTime": "2019-08-24T14:15:22Z",
      "syncSource": "GOOGLE",
      "tenantId": "string",
      "title": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string",
      "visibility": "PRIVATE"
    }
  ],
  "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 today's events

GET
/crm/calendar/events/today

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/events/today"
[
  {
    "allDay": true,
    "attendees": [
      {
        "email": "string",
        "name": "string",
        "status": "PENDING",
        "userId": "string"
      }
    ],
    "category": "DEFAULT",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customer": {
      "email": "string",
      "id": "string",
      "name": "string",
      "phone": "string"
    },
    "customerId": "string",
    "description": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "googleEventId": "string",
    "id": "string",
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "lead": {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string"
    },
    "leadId": "string",
    "location": "string",
    "onlineMeetingUrl": "string",
    "opportunity": {
      "id": "string",
      "name": "string",
      "status": "string"
    },
    "opportunityId": "string",
    "outlookEventId": "string",
    "owner": {
      "displayName": "string",
      "id": "string",
      "username": "string"
    },
    "ownerId": "string",
    "reminders": [
      {
        "minutesBefore": 0,
        "type": "NOTIFICATION"
      }
    ],
    "startTime": "2019-08-24T14:15:22Z",
    "syncSource": "GOOGLE",
    "tenantId": "string",
    "title": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "visibility": "PRIVATE"
  }
]
{
  "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 upcoming events

GET
/crm/calendar/events/upcoming

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

limit?integer
Default10
Formatint32

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/crm/calendar/events/upcoming"
[
  {
    "allDay": true,
    "attendees": [
      {
        "email": "string",
        "name": "string",
        "status": "PENDING",
        "userId": "string"
      }
    ],
    "category": "DEFAULT",
    "color": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "customer": {
      "email": "string",
      "id": "string",
      "name": "string",
      "phone": "string"
    },
    "customerId": "string",
    "description": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "googleEventId": "string",
    "id": "string",
    "lastSyncedAt": "2019-08-24T14:15:22Z",
    "lead": {
      "email": "string",
      "firstName": "string",
      "id": "string",
      "lastName": "string"
    },
    "leadId": "string",
    "location": "string",
    "onlineMeetingUrl": "string",
    "opportunity": {
      "id": "string",
      "name": "string",
      "status": "string"
    },
    "opportunityId": "string",
    "outlookEventId": "string",
    "owner": {
      "displayName": "string",
      "id": "string",
      "username": "string"
    },
    "ownerId": "string",
    "reminders": [
      {
        "minutesBefore": 0,
        "type": "NOTIFICATION"
      }
    ],
    "startTime": "2019-08-24T14:15:22Z",
    "syncSource": "GOOGLE",
    "tenantId": "string",
    "title": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string",
    "visibility": "PRIVATE"
  }
]
{
  "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 enriched calendar event

GET
/crm/calendar/events/{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/calendar/events/string"
{
  "allDay": true,
  "attendees": [
    {
      "email": "string",
      "name": "string",
      "status": "PENDING",
      "userId": "string"
    }
  ],
  "category": "DEFAULT",
  "color": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "googleEventId": "string",
  "id": "string",
  "lastSyncedAt": "2019-08-24T14:15:22Z",
  "lead": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string"
  },
  "leadId": "string",
  "location": "string",
  "onlineMeetingUrl": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "status": "string"
  },
  "opportunityId": "string",
  "outlookEventId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "reminders": [
    {
      "minutesBefore": 0,
      "type": "NOTIFICATION"
    }
  ],
  "startTime": "2019-08-24T14:15:22Z",
  "syncSource": "GOOGLE",
  "tenantId": "string",
  "title": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "visibility": "PRIVATE"
}
{
  "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 calendar event

PATCH
/crm/calendar/events/{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/calendar/events/string" \  -H "Content-Type: application/json" \  -d '{    "allDay": true,    "attendees": [      {        "email": "string",        "status": "PENDING"      }    ],    "category": "DEFAULT",    "endTime": "2019-08-24T14:15:22Z",    "reminders": [      {        "minutesBefore": 0,        "type": "NOTIFICATION"      }    ],    "startTime": "2019-08-24T14:15:22Z",    "title": "string",    "visibility": "PRIVATE"  }'
{
  "allDay": true,
  "attendees": [
    {
      "email": "string",
      "name": "string",
      "status": "PENDING",
      "userId": "string"
    }
  ],
  "category": "DEFAULT",
  "color": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "googleEventId": "string",
  "id": "string",
  "lastSyncedAt": "2019-08-24T14:15:22Z",
  "lead": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string"
  },
  "leadId": "string",
  "location": "string",
  "onlineMeetingUrl": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "status": "string"
  },
  "opportunityId": "string",
  "outlookEventId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "reminders": [
    {
      "minutesBefore": 0,
      "type": "NOTIFICATION"
    }
  ],
  "startTime": "2019-08-24T14:15:22Z",
  "syncSource": "GOOGLE",
  "tenantId": "string",
  "title": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "visibility": "PRIVATE"
}
{
  "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/calendar/events/{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/calendar/events/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/calendar/events/{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/calendar/events/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{
  "allDay": true,
  "attendees": [
    {
      "email": "string",
      "name": "string",
      "status": "PENDING",
      "userId": "string"
    }
  ],
  "category": "DEFAULT",
  "color": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "customer": {
    "email": "string",
    "id": "string",
    "name": "string",
    "phone": "string"
  },
  "customerId": "string",
  "description": "string",
  "endTime": "2019-08-24T14:15:22Z",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "googleEventId": "string",
  "id": "string",
  "lastSyncedAt": "2019-08-24T14:15:22Z",
  "lead": {
    "email": "string",
    "firstName": "string",
    "id": "string",
    "lastName": "string"
  },
  "leadId": "string",
  "location": "string",
  "onlineMeetingUrl": "string",
  "opportunity": {
    "id": "string",
    "name": "string",
    "status": "string"
  },
  "opportunityId": "string",
  "outlookEventId": "string",
  "owner": {
    "displayName": "string",
    "id": "string",
    "username": "string"
  },
  "ownerId": "string",
  "reminders": [
    {
      "minutesBefore": 0,
      "type": "NOTIFICATION"
    }
  ],
  "startTime": "2019-08-24T14:15:22Z",
  "syncSource": "GOOGLE",
  "tenantId": "string",
  "title": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "visibility": "PRIVATE"
}
{
  "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"
}

Calendar Connections

Previous Page

Cart

Next Page