Account Addresses
List Account Addresses
Returns all Account Addresses available in the user's ForceManager implementation database.
You will only receive the Account Addresses 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 |
| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
RESPONSE
This endpoint returns all Account Addresses available for the value list.
List of the supported Account Addresses attributes:
| Attribute | Type | Description |
|---|---|---|
| accountId | Object, Null | Account to which the address is linked to |
| address1 | String | Account's first address |
| address2 | String | Account's second address |
| city | String | City name |
| countryId | Object, Null | Id of the Country that the address is referred to (see Countries resource) |
| description | String | A description added to the Account Address |
| postcode | String | Postcode of the address |
| region | String | Region/State name |
| dateCreated | String | Date and time when the Account Address was created |
| dateDeleted | String | Date and time when the Account Address was deleted |
| dateUpdated | String | Date and time when the Account Address was last updated |
| deleted | Boolean | If true, the Account Address has been deleted and archived |
| id | Integer | Unique identifier for the Account Address in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Address |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Address |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account 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/accountAddresses
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/accountAddresses
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
List Account Addresses
Changes
No recorded changes to this operation across all 1 revision of this API.