closes

Get a close

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

get/v1/closes/{close_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: closes:read

Path parameters

close_idstring required
Example:cls_7mR3nQp8wL1YxTaK

Unique identifier for the close.

Query parameters

vehiclestring required
Example:vhcl_k9Rm3nQp8wL1YxTa

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

Response

The close.

createdinteger required

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

effective_atinteger required

The date this close took effect. Measured in seconds since the Unix epoch. Represents the date on which partners formally committed capital.

finalboolean required

Whether this is the final close for the vehicle.

idstring required

Unique identifier for this close. The underlying record id is encoded through a salted Sqid alphabet so the internal database identifier is never on the wire.

livemodeboolean required

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

object'close' required

Object type identifier.

partner_countinteger required

Number of partners that committed capital in this close.

Example response

{
  "commitment": {
    "currency": "USD",
    "formatted": "$1,000,000.00"
  },
  "contributed": {
    "currency": "USD",
    "formatted": "$1,000,000.00"
  },
  "id": "cls_7mR3nQp8wL1YxTaK",
  "partner_count": 15,
  "vehicle": {
    "id": "vhcl_k9Rm3nQp8wL1YxTa"
  }
}

Changes

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