Account Addresses
Get Account Address
This endpoint retrieves data of a specific Account Address based on JSON input. The API returns a single Address available to the user, according to the unique ID provided. If the specified Account Address does not exist, the response will be a "bad request".
You will only receive the Account Address 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 Address |
RESPONSE
| 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/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/accountAddresses/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Account Address
Changes
No recorded changes to this operation across all 1 revision of this API.