Activities / Entity
Get Activity
This endpoint retrieves data of a specific Activity based on JSON input. The API returns a single Activity available to the user, according to the unique ID provided. If the specified Activity does not exist, the response will be a "bad request".
You will only receive the Activity 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 Activity |
RESPONSE
| 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 |
get/activities/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/activities/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
ExtraFieldDescriptionstring
Response
Get Activity
Changes
No recorded changes to this operation across all 1 revision of this API.