List Calendar
Returns all Events and Tasks available in the user's ForceManager implementation database based on JSON input.
You will only receive the List of Events and Tasks 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 |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
| ExtraFieldDescription | {number} | If equal to "0", the response returns only the value of each Extra Fields, if equal to "1" also the description is returned |
REQUEST
You can apply filters, organise and choose the language and pagination using any query string parameter in SQL. Query string parameters appear after a question mark in the endpoint followed by the parameters and their values. In the query string, each parameter is listed one right after the other with an AND separating them. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| page | Integer | Define the pagination data for the returned objects |
| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |
| order | String | organise and view the results for a specific attribute in descendent order - at the top the most recent results while the oldest results will be down the list |
| lang | String | Define the language in which you want to receive the response |
You can define the pagination data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.
e.g.
https://api.forcemanager.com/api/v4/calendar?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/calendar?where= param1=value AND/OR param2=value2
You can filter Events and Tasks by accountId, salesRepId, startDate for example.
You can also organise and view the results for Event/Tasks in descendent order - at the top, the most recent results while the oldest results will be down the list.
e.g.
https://api.forcemanager.com/api/v4/calendar?order=VALUE
In the request, and using query string parameters, you can also define the language in which you want to receive the response.
e.g.
https://api.forcemanager.com/api/v4/calendar?lang=VALUE
RESPONSE
This endpoint returns information about all Event/Tasks available in the database.
If you didn't apply any page or count number in the header the default number of records in the response is 50.
List of the supported Event/Tasks attributes:
| 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 |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/calendar
- Auth: API key in header X-Session-Key
Headers
Response
List calendar
Changes
No recorded changes to this operation across all 1 revision of this API.