Skip to main content
GET
/
v1
/
distributions
List distributions
curl --request GET \
  --url https://api.nova.net/v1/distributions \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "object": "distribution",
      "livemode": true,
      "id": "dst_tQaOR74NP2DZ9mg3votpOnCqAuGs",
      "name": "April 20th Distribution from XYZ Sale",
      "distribution_date": "2024-04-20T00:00:00.000Z",
      "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"
                }
              ],
              "next_page_url": "/v1/distribution_payments/{payment_id}/notifications?page=page_5dr8SFDbv7rZ2aj4&limit=10",
              "previous_page_url": "/v1/distribution_payments/{payment_id}/notifications?page_before=page_8VtqLBv3xJpY7mk2&limit=10",
              "has_more": true,
              "url": "/v1/distribution_payments/{payment_id}/notifications"
            },
            "distribution_date_override": "2024-04-20T00:00:00.000Z"
          }
        ],
        "next_page_url": "/v1/distributions/{distribution_id}/payments?page=page_5dr8SFDbv7rZ2aj4&limit=10",
        "previous_page_url": "/v1/distributions/{distribution_id}/payments?page_before=page_8VtqLBv3xJpY7mk2&limit=10",
        "has_more": true,
        "url": "/v1/distributions/{distribution_id}/payments"
      }
    }
  ],
  "next_page_url": "/v1/distributions?page=page_5dr8SFDbv7rZ2aj4&limit=10",
  "previous_page_url": "/v1/distributions?page_before=page_8VtqLBv3xJpY7mk2&limit=10",
  "has_more": true,
  "url": "/v1/distributions"
}

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_EkzhrUc3U6C0UbxNBlK7WLz51ofT"

Query Parameters

​
page
string

Opaque cursor from a previous response next_page_url; returns the results after it

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

"page_QEpNuAot4c8XEGxH4UqLnO6Ao2Tf"

​
page_before
string

Opaque cursor from a previous response previous_page_url; returns the results before it

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

"page_QEpNuAot4c8XEGxH4UqLnO6Ao2Tf"

​
limit
integer
default:10

The maximum number of items to return.

Required range: 1 <= x <= 100

Response

List of distributions

​
object
enum<string>
required

Object type identifier.

Available options:
list
Example:

"list"

​
data
object[]
required

The page of items.

​
next_page_url
string | null
required

URL for the next page of the list, or null when there are no more pages.

Example:

"/v1/distributions?page=page_5dr8SFDbv7rZ2aj4&limit=10"

​
previous_page_url
string | null
required

URL for the previous page of the list, or null when there are none.

Example:

"/v1/distributions?page_before=page_8VtqLBv3xJpY7mk2&limit=10"

​
has_more
boolean
required
deprecated

Whether there are more items available after this page. Deprecated: next_page_url is non-null exactly when more pages exist.

​
url
string
required
deprecated

The URL for this list endpoint. Deprecated: follow next_page_url / previous_page_url to paginate.

Example:

"/v1/distributions"