Skip to main content
GET
/
v1
/
distributions
/
{id}
Retrieve a distribution
curl --request GET \
  --url https://api.nova.net/v1/distributions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "object": "distribution",
  "livemode": true,
  "id": "dst_tQaOR74NP2DZ9mg3votpOnCqAuGs",
  "name": "April 20th Distribution from XYZ Sale",
  "distribution_date": "2024-04-20T00:00:00Z",
  "vehicle": "veh_pNvehE6O1KjY2W6Omq9MD3QAEs5w",
  "external_reference": "distribution-123",
  "short_id": "<string>",
  "published_at": "2023-11-07T05:31:56Z",
  "approved_at": "2023-11-07T05:31:56Z",
  "executed_at": "2023-11-07T05:31:56Z",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "sender_url": "https://portal.angellist.com/path_to_sender_distribution",
  "recipient_url": "https://portal.angellist.com/path_to_recipient_distribution",
  "payments": {
    "object": "list",
    "data": [
      {
        "object": "distribution_payment",
        "livemode": true,
        "id": "dpmt_sSTfFdsytyOearj36zDNcmXn1pJ4",
        "amount": 1000,
        "currency": "USD",
        "status": "staged",
        "recipient_confirmed_at": "2023-11-07T05:31:56Z",
        "verified_at": "2023-11-07T05:31:56Z",
        "entity": "ent_H0hdMOc5E5QMTEcGVZKegvLNCB6p",
        "payment_instructions": "pmi_021wlGURMlk80cYuKBjENXqwC3OV",
        "notifications": {
          "object": "list",
          "data": [
            {
              "object": "distribution_notification",
              "livemode": true,
              "id": "dntf_bXlZNOmqHkAM8gS4h12vtwlI9sJx",
              "contact": "cnt_tSfCZrNE8O3c4QATSkzuCljMZ2DI"
            }
          ],
          "has_more": true,
          "url": "/v1/distribution_payments/{payment_id}/notifications"
        },
        "distribution_date_override": "2024-04-20T00:00:00Z"
      }
    ],
    "has_more": true,
    "url": "/v1/distributions/{distribution_id}/payments"
  }
}

Authorizations

​
Authorization
string
header
required

OAuth2 client_credentials grant for server-to-server access. Onboard via your Nova admin to receive a client_id and client_secret, then POST /oauth/token to exchange them for a short-lived access token. Send the token as Authorization: Bearer <access_token> on every authenticated request. Tokens expire after 3600 seconds — refresh by re-exchanging credentials.

Headers

​
X-Organization-Id
string

ID of the organization the request acts on. Optional when the access token is bound to a specific organization, or when the integration has access to exactly one organization.

Pattern: ^org_[A-Za-z0-9]+$
Example:

"org_Xk7d2pQR9m3nBwYz"

Path Parameters

​
id
string
required

ID of the distribution

Pattern: ^dst_[A-Za-z0-9]+$
Example:

"dst_tQaOR74NP2DZ9mg3votpOnCqAuGs"

Response

Distribution details

​
object
enum<string>
required

Object type identifier.

Available options:
distribution
Example:

"distribution"

​
livemode
boolean
required

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

​
id
string
required

ID of the distribution

Pattern: ^dst_[A-Za-z0-9]+$
Example:

"dst_tQaOR74NP2DZ9mg3votpOnCqAuGs"

​
name
string
required
Minimum string length: 1
Example:

"April 20th Distribution from XYZ Sale"

​
distribution_date
string<date-time>
required

Distribution date

Example:

"2024-04-20T00:00:00Z"

​
vehicle
string
required

ID of the vehicle this distribution pays from

Pattern: ^veh_[A-Za-z0-9]+$
Example:

"veh_pNvehE6O1KjY2W6Omq9MD3QAEs5w"

​
external_reference
string | null
required

Your own identifier for this distribution

Example:

"distribution-123"

​
short_id
string
required
​
status
enum<string>
required
Available options:
draft,
published,
approved,
executed,
cancelled
​
published_at
string<date-time> | null
required
​
approved_at
string<date-time> | null
required
​
executed_at
string<date-time> | null
required
​
cancelled_at
string<date-time> | null
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
sender_url
string<uri>
required

A link for the sender to manage this distribution in the Nova dashboard.

Example:

"https://portal.angellist.com/path_to_sender_distribution"

​
recipient_url
string<uri>
required

A link for any recipient to view this distribution in the Nova dashboard.

Example:

"https://portal.angellist.com/path_to_recipient_distribution"

​
payments
object
required