Accounts / Statuses
List Account Statuses
Returns all Account Statuses available in the user's ForceManager implementation database.
You will only receive the List of Account Statuses 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 |
RESPONSE
This endpoint returns information about all Account Statuses 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 Account Statuses attributes:
| Attribute | Type | Description |
|---|---|---|
| branchVisibility | Object, Null | In which Branch the Account Status is visible |
| won | Boolean | If true, the Account Status has been won |
| lost | Boolean | If true, the Account Status has been lost |
| dateCreated | String | Date and time when the Account Status was created |
| dateDeleted | String | Date and time when the Account Status was deleted |
| dateUpdated | String | Date and time when the Account Status was last updated |
| deleted | Boolean | If true, the Account Status has been deleted and archived |
| descriptionBR | String | Account Status label in Brasilian Portuguese |
| descriptionDE | String | Account Status label in German |
| descriptionDK | String | Account Status label in Dutch |
| descriptionEN | String | Account Status label in English |
| descriptionES | String | Account Status label in Spanish |
| descriptionFR | String | Account Status label in French |
| descriptionIT | String | Account Status label in Italian |
| descriptionPT | String | Account Status label in Portuguese |
| descriptionRU | String | Account Status label in Russian |
| descriptionUS | String | Account Status label in American English |
| id | Integer | Unique identifier for the Account Status in ForceManager |
| order | Integer | The position of the Account Status in the Account Statuses value list |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Status |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Status |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account Status |
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/accountStatuses
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/accountStatuses
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Countstring
ExtraFieldDescriptionstring
Response
List Account Statuses
Changes
No recorded changes to this operation across all 1 revision of this API.