List Entity Owners
Returns all Entity Owners available. Entity Owners are basically needed to associate more than one User to an Entity (e.g. the Opportunities with more than one sales rep).
You will only receive the Entity Owners 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 |
REQUEST
You can apply filters, organise and choose the language and pagination using any query string parameter in SQL. Query string parameters appear after a question mark in the endpoint followed by the parameters and their values. In the query string, each parameter is listed one right after the other with an AND separating them. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| page | Integer | Define the pagination data for the returned objects |
| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |
| order | String | organise and view the results for a specific attribute in descendent order - at the top the most recent results while the oldest results will be down the list |
| lang | String | Define the language in which you want to receive the response |
You can define the pagination data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.
e.g.
https://api.forcemanager.com/api/v4/entityOwners?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/entityOwners?where= param1=value AND/OR param2=value2
You can filter Entity Owners by entityId or salesRepId for example.
RESPONSE
This endpoint returns all Entity Owners available for the value list.
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 Entity Owners attributes:
| Attribute | Type | Description |
|---|---|---|
| entityId | Integer | The ID of the corresponding Entity that the User is associated to |
| entityTypeId | Integer | The Entity type: 1 for Opportunity, 2 for Account, 3 for Contact, 4 for Activity |
| salesRepOrder | Integer | The order in which the User has to appear in the Entity Owners list |
| dateCreated | String | Date and time when the Entity Owner was created |
| dateDeleted | String | Date and time when the Entity Owner was deleted |
| dateUpdated | String | Date and time when the Entity Owner was last updated |
| deleted | Boolean | If true, the Entity Owner has been deleted and archived |
| id | Integer | Unique identifier for the Entity Owner in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Entity Owner |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Entity Owner |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Entity Owner |
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 |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/entityOwners
- Auth: API key in header X-Session-Key
Headers
Response
List Entity Owners
Changes
No recorded changes to this operation across all 1 revision of this API.