Accounts / Entity
Get Account
This endpoint retrieves data of a specific Account based on JSON input. The API returns a single Account available to the user, according to the unique ID provided. If the specified Account does not exist, the response will be a "bad request".
You will only receive the Account 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 Account |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| address1 | String | The Account's main address. e.g. number, street, suite, apt#, postal code, etc. |
| address2 | String | The Account's second address |
| branchId | Object, Null | Branch to which the Account has been assigned (see Branches resource) |
| city | String | City name |
| comment | Object | Comment added to the Account |
| countryId | Object, Null | Country ID (see Countries resource) of the Account address |
| dateCreated | String | Date and time when the Account was created |
| dateDeleted | String | Date and time when the Account was deleted |
| dateUpdated | string | Date and time when the Account was last updated |
| deleted | Boolean | If true, the Account has been deleted and archived |
| String | Account's email address | |
| extId | String | External ID of the Account from a third party system (ERP, CRM, Accounting System) |
| fax | String | Account's fax number |
| geocoded | Boolean | If true, the Account has been geolocated |
| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |
| id | Integer | Unique identifier for the Account in ForceManager |
| latitude | Number | Geocode address for the latitude coordinates |
| longitude | Number | Geocode address for the longitude coordinates |
| name | String | Name of the Account |
| permissionLevel | String | Defines the visibility of the Account. Set from 1 to 5 being 5 the highest level of permission |
| phone | String | First contact phone number for the Account |
| phone2 | String | Second contact phone number for the Account |
| phone3 | String | Third contact phone number for the Account |
| postcode | String | The Account's address postcode |
| public | Boolean | If true, the Account is visible to everyone regardless of the level of permission |
| rateId | Integer | Rate for the Account (see Rates resource) |
| readOnly | boolean | If true, the Account can not be modified or deleted |
| region | String | Region/State name |
| salesRepId1 | Object, Null | First User responsible for the Account |
| salesRepId2 | Object, Null | Second User responsible for the Account |
| salesRepId3 | Object, Null | Third User responsible for the Account |
| salesRepId4 | Object, Null | Forth User responsible for the Account |
| salesRepId5 | Object, Null | Fifth User responsible for the Account |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Account |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Account |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Account |
| segmentId | Object, Null | Segment of the Account (see Segments resource) |
| statusId | Object, Null | Status of the Account (see Statues resource) |
| typeId | Object, Null | Type of the Account (see Types resource) |
| vatNumber | String | Value Added Tax identification number of the Account |
| website | String | The Account's website address |
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/accounts/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/accounts/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
ExtraFieldDescriptionstring
Response
Get Account
Changes
No recorded changes to this operation across all 1 revision of this API.