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