List Accounts
Returns all Accounts available in the user's ForceManager implementation database.
You will only receive the List of Accounts 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/accounts?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/accounts?where= param1=value AND/OR param2=value2
You can filter Accounts by dateCreated or address, or typeId for example.
You can also organise and view the results for Accounts 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/accounts?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/accounts?lang=VALUE
RESPONSE
This endpoint returns information about all Accounts 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 Accounts attributes:
| 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 |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/accounts
- Auth: API key in header X-Session-Key
Headers
Response
List Accounts
Changes
No recorded changes to this operation across all 1 revision of this API.