GuidesRecipesAPI Reference
Log In
Guides

Retrieve contacts information

Retrieve all contacts in the database

Value
DescriptionRetrieve All contacts. Response data includes both standard and dynamic fields.
Path/api/crm/contacts/list
MethodGET
Request parametersN/A
Request bodyN/A
Responses200 (OK): Array of contact data
403 (Forbidden): User doesn't have appropriate permission to All master fund Contact.
ReferenceLink

Response body example

Retrieve all contacts within a given fund

Value
DescriptionRetrieve contacts linked to a specific fund. The response data includes both standard and dynamic fields.
Path/api/crm/contacts/list/{fundVehicleInternalId}
MethodGET
Request ParametersfundVehicleInternalId: An internal ID of the specific fund of which’s contact list you want to retrieve.
Request BodyN/A
Responses200 (OK): Array of contact data with roles.
403 (Forbidden): User doesn't have permission to All master fund Contact.
ReferenceLink

Response body example

Retrieve all contacts linked to an investor

Value
DescriptionRetrieve 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}
MethodGET
Request ParametersinvestorCrmInternalId: An internal ID of investor for whom you want to retrieve the contact list.
Request BodyN/A
Responses200 (OK): Array of contact data
403 (Forbidden): User doesn't have permission to All master fund Contact.
ReferenceLink

Response body example

Retrieve all contacts of a specific role

Value
DescriptionRetrieve multiple contacts of a specified role. The response data includes both standard and dynamic fields.
Path/api/crm/contacts/list/{roleInternalId}
MethodGET
Request ParametersroleInternalId: An internal ID of role which you want to get contact list.
Request BodyN/A
Responses200 (OK): Array of contact data with roles.
403 (Forbidden): User doesn't have permission to All master fund Contact.
ReferenceLink

Response body example