ANangellist
deployments

Get a deployment

Returns a single deployment by ID. The vehicle query parameter is required for authorization — the caller must have access to the vehicle the deployment belongs to.

get/v1/deployments/{deployment_id}

Request

  • Base URL
    https://api.angellist.com
  • Auth
    OAuth 2
    Authorization code: https://gateway.angellist.com/oauth/authorize
    Client credentials
    Token URL: https://gateway.angellist.com/oauth/token scopes: deployments:read

Path parameters

deployment_idstring required
Example:dply_4kP9wL2nXyTaQ7vR

Unique identifier for the deployment.

Query parameters

vehiclestring required
Example:vhcl_k9Rm3nQp8wL1YxTa

Vehicle the deployment belongs to. Required for authorization. Must be a vehicle of type spv, ruv, or venture_fund.

Response

The deployment.

createdinteger required

Time at which the deployment record was created. Measured in seconds since the Unix epoch.

deployed_atinteger required

Time at which the capital was deployed. Measured in seconds since the Unix epoch.

idstring required

Unique identifier for this deployment. Encodes the CPTR asset that materializes the deployment through a salted Sqid alphabet so internal database identifiers never reach the wire.

instrument_type'equity' | 'safe' | 'convertible_note' | 'fund_interest' | 'token' | 'warrant' | 'other' required

The instrument type deployed.

livemodeboolean required

Whether this object exists in live mode (true) or test mode (false).

object'deployment' required

Object type identifier.

roundstring required

The financing round label (e.g. Series A).

Example response

{
  "amount": {
    "currency": "USD",
    "formatted": "$1,000,000.00"
  },
  "asset": {
    "id": "asst_8xK2mN4pR8qS1tV7"
  },
  "company": {
    "id": "cmpny_AJqi2An4xbPF2fbz3f9DZhVL8tDCH"
  },
  "id": "dply_4kP9wL2nXyTaQ7vR",
  "instrument_type": "equity",
  "round": "Series A",
  "vehicle": {
    "id": "vhcl_k9Rm3nQp8wL1YxTa"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.