ANangellist
distributions

Get a distribution

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

get/v1/distributions/{distribution_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: distributions:read

Path parameters

distribution_idstring required
Example:dist_5tV7xK2mN4pR8qS1

Unique identifier for the distribution.

Query parameters

vehiclestring required
Example:vhcl_k9Rm3nQp8wL1YxTa

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

Response

The distribution.

categorystring nullable

Economic category selected for the distribution. Null when the source workflow does not classify the distribution.

createdinteger required

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

effective_atinteger nullable

Requested effective date, measured in seconds since the Unix epoch at UTC midnight. This is not proof that the distribution executed on that date. Null when no requested effective date is available.

executed_atinteger nullable

Time at which the distribution was executed. Measured in seconds since the Unix epoch. Null when the distribution has not yet been executed.

idstring required

Unique identifier for this distribution. 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'distribution' required

Object type identifier.

status'pending' | 'approved' | 'completed' required

Current lifecycle status of the distribution.

stock_quantityinteger nullable

Number of shares distributed in-kind. Null when the distribution is entirely cash or no executed in-kind quantity is available.

Example response

{
  "cash": {
    "currency": "USD",
    "formatted": "$1,000,000.00"
  },
  "category": "return_of_capital",
  "id": "dist_5tV7xK2mN4pR8qS1",
  "tax_withholding": {
    "currency": "USD",
    "formatted": "$1,000,000.00"
  },
  "total": {
    "currency": "USD",
    "formatted": "$1,000,000.00"
  },
  "vehicle": {
    "id": "vhcl_k9Rm3nQp8wL1YxTa"
  }
}

Changes

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