List Activities
Returns all Activities available in the user's ForceManager implementation database.
You will only receive the List of Activities 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/activities?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/activities?where= param1=value AND/OR param2=value2
You can filter Activities by dateCreated or typeId, or accountId for example.
You can also organise and view the results for Activities 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/activities?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/activities?lang=VALUE
RESPONSE
This endpoint returns information about all Activities 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 Activities attributes:
| Attribute | Type | Description |
|---|---|---|
| accountId (Required) | Object, Null | ID of the Account to which the Activity is linked to (see Accounts resource) |
| contactId | Object, Null | Contact the Activity is linked to (see Contacts resource) |
| opportunityId | Object, Null | Opportunity to which the Activity is linked to (see Opportunities resource) |
| typeId (Required) | Object, Null | Activity Type ID (see Types resource) |
| salesRepId | Object, Null | Unique identifier of the User associated to the Activity (see Users resource) |
| checkin | Boolean | True in the case the Activity had been certified to done within the geofencing range, false otherwise |
| checkinTypeId | Integer | It exists three different types of checkin: 1 (check-in at an Account's location); 2 (check-in at an open Opportunity); 3 (fast check-in when a User reports a physical visit without having to link them to any existing Account or Opportunity in ForceManager) |
| checkoutDate | String | Date and time for the check-out. Registers the end of a visit to a client |
| comment | String | A comment of the Activity |
| date (Required) | String | Date referred to the moment in which the Activity took place |
| geocoded | Boolean | If true, the Activity has been geolocated and a geocode is automatically calculated by the system (latitude and longitude) |
| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |
| latitude | Number | Geocode address for the latitude coordinates |
| longitude | Number | Geocode address for the longitude coordinates |
| permissionLevel | String | Defines the visibility of the Activity. Set from 1 to 5 being 5 the highest level of permission |
| readOnly | Boolean | If true, the Activity cannot be modified or deleted |
| extId | String | External ID of the Activity from a third party system (ERP, CRM, Accounting System) |
| id | Integer | Unique identifier for the Activity in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Activity |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Activity |
| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Activity |
| dateCreated | String | Date and time when the Activity was created |
| dateDeleted | String | Date and time when the Activity was deleted |
| dateUpdated | String | Date and time when the Activity was last updated |
| deleted | boolean | If true, the Activity has been deleted and archived |
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/activities
- Auth: API key in header X-Session-Key
Headers
Response
List Activities
Changes
No recorded changes to this operation across all 1 revision of this API.