GuidesRecipesAPI Reference
Log In
Guides

Fetch Investee fund entities

List of all Investee fund entities

This API retrieves a list of all investee fund entities in the company. The response is an array of objects excluding custom/dynamic fields. If no investee fund entities are found, the API returns an empty array.

Value
DescriptionGet list of investee fund entities in the company.
Path/api/entities/investeefund/list/all
MethodGET
Request ParametersN/A
Request BodyN/A
Responses
  • *200 (OK):** Return array of object. A new investee fund deactivates successfully.
  • *401 (Unauthorized):** Access token is not valid.

List of Investee fund entities in a scope

This API retrieves a list of all investee fund entities within the scope. The response is an array of objects excluding custom/dynamic fields. If no investee fund entities are found, the API returns an empty array.

Value
DescriptionGet list of investee fund entities in a scope.
Path/api/entities/investeefund/perscope/{scopeId}
MethodGET
Request Parameters
  • *scopeId:** Scope internal id that a new investee fund creates on that scope.
Request BodyN/A
Responses
  • *200 (OK):** Return array of object. A new investee fund deactivates successfully.
  • *401 (Unauthorized):** Access token is not valid.
  • *403 (Forbidden):** Access token has no permission.

Get an individual investee fund entity with custom fields included

This API retrieves an investee fund entity based on a specific scope and either an ID or an internal ID. The response is an object that includes custom/dynamic fields. If the investee fund entity is not found, the API returns a 404 status code.

Value
DescriptionGet an investee fund entity with custom/dynamic field.
Path/api/entities/investeefund/{scopeId}/{fundIdOrInternalId}/{asOfDate}
MethodGET
Request Parameters
  • scopeId: *Scope internal id that a new investee fund creates on that scope.
  • *fundIdOrInternalId:** The existing investee fund id or internal id that needs to update.
    asOfDate: The date that wants to retrieve custom/dynamic field data. Its format should be ‘YYYY-MM-DD'.
Request BodyN/A
Responses
  • *200 (OK):** return Object, A new investee fund deactivates successfully.
  • 401 (Unauthorized): *Access token is not valid.
  • 403 (Forbidden): *Access token has no permission.
  • *404 (Not found):** fundIdOrInternalId value does not exist in our system.

Updated about 1 year ago