Related Accounts / Entity
Retrieve Related Account
This endpoint retrieves data of a specific Related Account based on JSON input. The API returns a single Related Account available to the user, according to the unique ID provided. If the specified Related Account does not exist, the response will be a "bad request".
You will only receive the Related Account 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 for the Related Account |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| accountOneId | Number, Null | First Account to be referred to the relationships |
| accountTwoId | Number, Null | Second Account to be referred to the relationships |
| relationId | Number, Null | Related Account Type that defines the type of the relationships (see Types resource) |
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/accountsRelated/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/accountsRelated/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Retrieve Related Account
Changes
No recorded changes to this operation across all 1 revision of this API.