Skip to main content
GET
/
v1
/
entities
List entities
curl --request GET \
  --url https://api.nova.net/v1/entities \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "object": "entity",
      "livemode": true,
      "id": "ent_H0hdMOc5E5QMTEcGVZKegvLNCB6p",
      "name": "Jane Doe, LLC",
      "type": "individual",
      "external_reference": "entity-123",
      "payment_instructions": {
        "object": "list",
        "data": [
          "pmi_021wlGURMlk80cYuKBjENXqwC3OV"
        ],
        "next_page_url": "/v1/entities/ent_123/payment_instructions?page=page_5dr8SFDbv7rZ2aj4&limit=10",
        "previous_page_url": "/v1/entities/ent_123/payment_instructions?page_before=page_8VtqLBv3xJpY7mk2&limit=10",
        "has_more": true,
        "url": "/v1/entities/ent_123/payment_instructions"
      },
      "external_type": "<string>"
    }
  ],
  "next_page_url": "/v1/entities?page=page_5dr8SFDbv7rZ2aj4&limit=10",
  "previous_page_url": "/v1/entities?page_before=page_8VtqLBv3xJpY7mk2&limit=10",
  "has_more": true,
  "url": "/v1/entities"
}

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 entities

​
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/entities?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/entities?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/entities"