Events/Tasks
Get Calendar
This endpoint retrieves data of a specific calendar Event or Task based on JSON input. The API returns a single Type available to the user, according to the unique ID provided. If the specified calendar Event or Task does not exist, the response will be a "bad request".
You will only receive the calendar Event or Task after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the calendar Event or Task |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| accountId | Object, Null | Account to which the Event/Task is linked |
| allDay | Boolean | If true, the Event/Task takes all day, it does not have a start and end time specified |
| branchId | Object, Null | Branch the Event/Task is assigned to |
| city | String | City name |
| comment | String | Comment added to the Event/Task |
| contactId | Object, Null | Contact to which an Event/Task is linked |
| dateCreated | String | Date and time when the Event/Task was created |
| dateDeleted | String | Date and time when the Event/Task was deleted |
| dateUpdated | String | Date and time when the Event/Task was last updated |
| deleted | Boolean | If true, the Account has been deleted and archived |
| endDate | String | End Date and time of the Event/Task |
| extId | String | External ID of the Event/Task from a third party system (ERP, CRM, Accounting System) |
| id | Integer | The Event/Task's unique identifier |
| opportunityId | Object, Null | Opportunity to which the Event/Task is linked |
| permissionLevel | String | Defines the visibility of the Event/Task. Set from 1 to 5 being 5 the highest level of permission |
| readOnly | Boolean | If true, the Event/Task can not be modified or deleted |
| reminder | Integer | Time before the Event/Task when you want to be reminded of it: -2: not used, 1: Remind at the start time, 5: 5 minutes before to start, 15: 15 minutes before to start, 30: 30 minutes before to start, 1440: 1 hour before to start, 3600: 1 days before to start, 10080: 1 week before to start |
| salesRepId | Object, Null | User responsible for this Event/Task |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Event/Task |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Event/Task |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Event/Task |
| sendNotification | Boolean | If true, an invitation email will be sent to the Contacts of the Event/Task |
| startDate | String | Start Date of the Event/Task |
| startHour | String | Start hour of the Event/Task |
| subject | String | Description or name of the Event/Task |
| task | Boolean | If true, the entity is a Task. Then endDate and endHour is not needed |
| typeId | Object, Null | Type of the Event/Task. e.g. meeting, visit, etc. |
| completed | Boolean | If true, the Task is considered completed |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/calendar/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/calendar/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
ExtraFieldDescriptionstring
Response
Get calendar
Changes
No recorded changes to this operation across all 1 revision of this API.