Retrieve contacts information
Retrieve all contacts in the database
Value | |
---|---|
Description | Retrieve All contacts. Response data includes both standard and dynamic fields. |
Path | /api/crm/contacts/list |
Method | GET |
Request parameters | N/A |
Request body | N/A |
Responses | 200 (OK): Array of contact data 403 (Forbidden): User doesn't have appropriate permission to All master fund Contact. |
Reference | Link |
Response body example
Retrieve all contacts within a given fund
Value | |
---|---|
Description | Retrieve contacts linked to a specific fund. The response data includes both standard and dynamic fields. |
Path | /api/crm/contacts/list/{fundVehicleInternalId} |
Method | GET |
Request Parameters | fundVehicleInternalId: An internal ID of the specific fund of which’s contact list you want to retrieve. |
Request Body | N/A |
Responses | 200 (OK): Array of contact data with roles. 403 (Forbidden): User doesn't have permission to All master fund Contact. |
Reference | Link |
Response body example
Retrieve all contacts linked to an investor
Value | |
---|---|
Description | Retrieve multiple contacts of an investor. The returned data includes both standard and dynamic fields, if a configuration is present |
Path | /api/crm/contacts/list/{investorCrmInternalId} |
Method | GET |
Request Parameters | investorCrmInternalId: An internal ID of investor for whom you want to retrieve the contact list. |
Request Body | N/A |
Responses | 200 (OK): Array of contact data 403 (Forbidden): User doesn't have permission to All master fund Contact. |
Reference | Link |
Response body example
Retrieve all contacts of a specific role
Value | |
---|---|
Description | Retrieve multiple contacts of a specified role. The response data includes both standard and dynamic fields. |
Path | /api/crm/contacts/list/{roleInternalId} |
Method | GET |
Request Parameters | roleInternalId: An internal ID of role which you want to get contact list. |
Request Body | N/A |
Responses | 200 (OK): Array of contact data with roles. 403 (Forbidden): User doesn't have permission to All master fund Contact. |
Reference | Link |
Response body example
Updated over 1 year ago