GuidesRecipesAPI Reference
Log In
Guides

Get deactivated entities

Definition

This API returns a list of all deactivated entities within a specified period. These include all Quantium entities namely:

  • Fund vehicle
  • Asset
  • Investor
  • Investor group
  • Investee fund
  • Spv
Value
DescriptionRetrieves deactivated entities in specific period. This specific period must not exceed 3 months.
Path/api/entities/deactivated/timerange/{from}/{to}
MethodGET
Request Parametersfrom: Start date time in format ISO8601 with UTC. i.e., 2023-08-01T00:00:00z

to: Start date time in format ISO8601 with UTC. i.e., 2023-08-01T00:00:00z
Request BodyN/A
Responses200 (OK): The deactivated entities object

400 (Bad Request): The given from / to date time parameters are in incorrect format. Please provide the input in the “yyyy-MM-ddTHH:mm:ssz” format (e.g. 2022-12-31T13:00:00z).

400 (Bad Request): The provided from date time should be before the than to datetime.

400 (Bad Request): The provided from / to datetime should not exceed 3 months.

400 (Bad Request): Invalid HTTP request, unable to extract user information from this request.

Request body fields

NameType
assetIdsint
assetInternalIdsstring
fundVehicleIdsint
fundVehicleInternalIdsstring
investorIdsint
investorInternalIdsstring
investeeFundIdsint
investeeFundInternalIdsstring
investorGroupInternalIdsstring
spvIdsint
spvInternalIdsstring
commitmentIdsint
contactInternalIdsstring
contactRoleInternalIdsstring
investeeFundCommitmentIdsint
journalIdsint

Example response

{
    "assetIds": [],
    "assetInternalIds": [],
    "fundVehicleIds": [
        339,
        340,
        341,
        342,
        343,
        344,
        348,
        349
    ],
    "fundVehicleInternalIds": [
        "6667f57cf61c1e8667a7e49d",
        "6667f57cf61c1e8667a7e49e",
        "6667f57cf61c1e8667a7e49f",
        "6667f57cf61c1e8667a7e4a0",
        "6667f57cf61c1e8667a7e4a1",
        "6667f57cf61c1e8667a7e4a2",
        "667a38e37b6ce5c501c39147",
        "6684ff1cdf4fb57b463e9db7"
    ],
    "investorIds": [],
    "investorInternalIds": [],
    "investeeFundIds": [],
    "investeeFundInternalIds": [],
    "investorGroupInternalIds": [],
    "spvIds": [],
    "spvInternalIds": [],
    "commitmentIds": [
        346,
        346
    ],
    "contactInternalIds": [
        "6408230bac7a204cd7d80d72",
        "660f6a68b411c100c267e739"
    ],
    "contactRoleInternalIds": [],
    "investeeFundCommitmentIds": [
        16
    ],
    "journalIds": [
        6797,
        5907,
        6687
    ]
}