Related Accounts / Types
Retrieve Related Account Type
This endpoint retrieves data of a specific Related Account Type based on JSON input. The API returns a single Type available to the user in the Value List, according to the unique ID provided. If the specified Related Account Type does not exist, the response will be a "bad request".
You will only receive the Related Account Type 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 Related Account Type |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| descriptionBR | String | Direct relationship name of the Related Account Type in Brasilian Portuguese |
| descriptionDE | String | Direct relationship name of the Related Account Type in German |
| descriptionDK | String | Direct relationship name of the Related Account Type in Dutch |
| descriptionEN | String | Direct relationship name of the Related Account Type in English |
| descriptionES | String | Direct relationship name of the Related Account Type in Spanish |
| descriptionFR | String | Direct relationship name of the Related Account Type in French |
| descriptionIT | String | Direct relationship name of the Related Account Type in Italian |
| descriptionPT | String | Direct relationship name of the Related Account Type in Portuguese |
| descriptionRU | String | Direct relationship name of the Related Account Type in Russian |
| descriptionUS | String | Direct relationship name of the Related Account Type in American English |
| reverseDescriptionBR | String | Inverse relationship name of the Related Account Type in Brasilian Portuguese |
| reverseDescriptionDE | String | Inverse relationship name of the Related Account Type in German |
| reverseDescriptionDK | String | Inverse relationship name of the Related Account Type in Dutch |
| reverseDescriptionEN | String | Inverse relationship name of the Related Account Type in English |
| reverseDescriptionES | String | Inverse relationship name of the Related Account Type in Spanish |
| reverseDescriptionFR | String | Inverse relationship name of the Related Account Type in French |
| reverseDescriptionIT | String | Inverse relationship name of the Related Account Type in Italian |
| reverseDescriptionPT | String | Inverse relationship name of the Related Account Type in Portuguese |
| reverseDescriptionRU | String | Inverse relationship name of the Related Account Type in Russian |
| reverseDescriptionUS | String | Inverse relationship name of the Related Account Type in American English |
| id | Integer | Unique identifier for the Related Account Type in ForceManager |
| dateCreated | String | Date and time when the Related Account Type was created |
| dateDeleted | String | Date and time when the Related Account Type was deleted |
| dateUpdated | String | Date and time when the Related Account Type was last updated |
| deleted | Boolean | If true, the Related Account Type has been deleted and archived |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Related Account Type |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Related Account Type |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Related Account Type |
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/accountsRelations/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/accountsRelations/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Retrieve Related Account Type
Changes
No recorded changes to this operation across all 1 revision of this API.