> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nova.net/llms.txt
> Use this file to discover all available pages before exploring further.

# List entities

> List entities with pagination



## OpenAPI

````yaml /openapi.yaml get /v1/entities
openapi: 3.0.4
info:
  title: Nova API
  version: 1.2.0
  contact:
    name: Nova Engineering
    email: support@nova.net
  description: >-
    The Nova API exposes programmatic access to fund operations including
    distributions, vehicles, entities, and contacts. Authentication is via
    OAuth2 client_credentials with per-scope authorization. All write operations
    require an `X-Organization-Id` header identifying the acting organization.
servers:
  - url: https://api.nova.net
  - url: https://api-sandbox.nova.net
security:
  - OAuth2: []
tags:
  - name: Authentication
    description: OAuth2 client_credentials token exchange
  - name: Distributions
    description: Manage distributions
  - name: Entities
    description: Manage entities
  - name: Payment Instructions
    description: Manage payment instructions for entities
  - name: Contacts
    description: Manage contacts
paths:
  /v1/entities:
    get:
      tags:
        - Entities
      summary: List entities
      description: List entities with pagination
      operationId: listEntities
      parameters:
        - schema:
            type: string
            pattern: ^page_[A-Za-z0-9]+$
            description: >-
              Opaque cursor from a previous response `next_page_url`; returns
              the results after it
            example: page_QEpNuAot4c8XEGxH4UqLnO6Ao2Tf
          required: false
          description: >-
            Opaque cursor from a previous response `next_page_url`; returns the
            results after it
          name: page
          in: query
        - schema:
            type: string
            pattern: ^page_[A-Za-z0-9]+$
            description: >-
              Opaque cursor from a previous response `previous_page_url`;
              returns the results before it
            example: page_QEpNuAot4c8XEGxH4UqLnO6Ao2Tf
          required: false
          description: >-
            Opaque cursor from a previous response `previous_page_url`; returns
            the results before it
          name: page_before
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 10
            description: The maximum number of items to return.
          required: false
          description: The maximum number of items to return.
          name: limit
          in: query
        - $ref: '#/components/parameters/OrganizationId'
      responses:
        '200':
          description: List of entities
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityList'
        '400':
          description: Invalid pagination parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid access token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Missing required OAuth scope or organization access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded
          headers:
            Retry-After:
              schema:
                type: integer
                description: >-
                  Seconds until the rate-limit window resets. Present on 429
                  responses.
              required: true
              description: >-
                Seconds until the rate-limit window resets. Present on 429
                responses.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Upstream service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - OAuth2:
            - entities:read
components:
  parameters:
    OrganizationId:
      schema:
        $ref: '#/components/schemas/OrganizationId'
      required: false
      description: >-
        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.
      name: X-Organization-Id
      in: header
  schemas:
    EntityList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
          description: Object type identifier.
          example: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Entity'
          description: The page of items.
        next_page_url:
          type: string
          nullable: true
          description: >-
            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:
          type: string
          nullable: true
          description: >-
            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:
          type: boolean
          description: >-
            Whether there are more items available after this page. Deprecated:
            `next_page_url` is non-null exactly when more pages exist.
          deprecated: true
        url:
          type: string
          description: >-
            The URL for this list endpoint. Deprecated: follow `next_page_url` /
            `previous_page_url` to paginate.
          example: /v1/entities
          deprecated: true
      required:
        - object
        - data
        - next_page_url
        - previous_page_url
        - has_more
        - url
      additionalProperties: false
    Error:
      type: object
      properties:
        object:
          type: string
          enum:
            - error
          description: Object type identifier.
          example: error
        type:
          $ref: '#/components/schemas/ApiErrorType'
        code:
          $ref: '#/components/schemas/ApiErrorCode'
        message:
          type: string
          description: Human-readable error message intended for developers, not end-users.
        status:
          type: integer
          description: HTTP status code.
          example: 404
        doc_url:
          type: string
          format: uri
          description: Link to documentation about this error.
        request_id:
          type: string
          description: Request identifier for support inquiries.
        invalid-params:
          type: array
          items:
            type: object
            properties:
              code:
                $ref: '#/components/schemas/ApiErrorCode'
              name:
                type: string
                description: The request parameter that caused the error.
              reason:
                type: string
                description: Human-readable explanation of why the parameter is invalid.
              value:
                oneOf:
                  - type: string
                  - type: number
                  - type: boolean
                  - nullable: true
                description: >-
                  The value of the request parameter that caused the error, if
                  applicable.
              conflicts_with:
                type: string
                description: >-
                  For conflict errors, the id of the existing resource this
                  parameter conflicts with.
            required:
              - code
              - name
              - reason
          description: The request parameters that caused the error, if applicable.
      required:
        - object
        - type
        - code
        - message
        - status
      example:
        object: error
        type: invalid_request_error
        code: parameter_invalid
        message: The 'limit' parameter must be between 1 and 100.
        status: 400
        invalid-params:
          - code: parameter_invalid
            name: body.[0].limit
            value: 200
            reason: out of range
    OrganizationId:
      type: string
      pattern: ^org_[A-Za-z0-9]+$
      description: >-
        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.
      example: org_EkzhrUc3U6C0UbxNBlK7WLz51ofT
    Entity:
      type: object
      properties:
        object:
          type: string
          enum:
            - entity
          description: Object type identifier.
          example: entity
        livemode:
          type: boolean
          description: >-
            Whether this object exists in live mode (`true`) or test mode
            (`false`).
        id:
          type: string
          pattern: ^ent_[A-Za-z0-9]+$
          description: ID of the entity
          example: ent_H0hdMOc5E5QMTEcGVZKegvLNCB6p
        name:
          type: string
          minLength: 1
          maxLength: 255
          description: Legal name of the entity
          example: Jane Doe, LLC
        type:
          $ref: '#/components/schemas/EntityType'
        external_type:
          type: string
          description: Your own type for this entity
        external_reference:
          type: string
          nullable: true
          description: Your identifier for this entity
          example: entity-123
        payment_instructions:
          $ref: '#/components/schemas/PaymentInstructionsList'
      required:
        - object
        - livemode
        - id
        - name
        - type
        - external_reference
        - payment_instructions
      additionalProperties: false
    ApiErrorType:
      type: string
      enum:
        - authentication_error
        - permission_error
        - invalid_request_error
        - not_found_error
        - request_timeout_error
        - conflict_error
        - rate_limit_error
        - api_error
      description: Machine-readable high-level error category.
    ApiErrorCode:
      oneOf:
        - type: string
          enum:
            - unauthorized
            - forbidden
            - resource_not_found
            - request_timeout
            - conflict
            - idempotency_mismatch
            - rate_limit_exceeded
            - internal_error
            - not_implemented
            - bad_gateway
        - $ref: '#/components/schemas/ValidationCode'
      description: Machine-readable high-level error code.
    EntityType:
      type: string
      enum:
        - individual
        - individual_retirement_plan
        - corporation
        - llc
        - partnership
        - trust
        - joint_tenants_ros
        - tenants_in_common
        - community_property
        - registered_investment_company
        - foundation
        - charitable_remainder_trust
        - endowment
        - employee_benefit_plan
        - keogh_plan
        - other_entity
      example: individual
    PaymentInstructionsList:
      type: object
      properties:
        object:
          type: string
          enum:
            - list
          description: Object type identifier.
          example: list
        data:
          type: array
          items:
            type: string
            pattern: ^pmi_[A-Za-z0-9]+$
            description: ID of the payment instructions
            example: pmi_021wlGURMlk80cYuKBjENXqwC3OV
          description: The page of items.
        next_page_url:
          type: string
          nullable: true
          description: >-
            URL for the next page of the list, or `null` when there are no more
            pages.
          example: >-
            /v1/entities/ent_123/payment_instructions?page=page_5dr8SFDbv7rZ2aj4&limit=10
        previous_page_url:
          type: string
          nullable: true
          description: >-
            URL for the previous page of the list, or `null` when there are
            none.
          example: >-
            /v1/entities/ent_123/payment_instructions?page_before=page_8VtqLBv3xJpY7mk2&limit=10
        has_more:
          type: boolean
          description: >-
            Whether there are more items available after this page. Deprecated:
            `next_page_url` is non-null exactly when more pages exist.
          deprecated: true
        url:
          type: string
          description: >-
            The URL for this list endpoint. Deprecated: follow `next_page_url` /
            `previous_page_url` to paginate.
          example: /v1/entities/ent_123/payment_instructions
          deprecated: true
      required:
        - object
        - data
        - next_page_url
        - previous_page_url
        - has_more
        - url
      additionalProperties: false
    ValidationCode:
      type: string
      enum:
        - parameter_missing
        - parameter_unknown
        - parameter_invalid
        - parameter_invalid_string
        - parameter_invalid_string_empty
        - parameter_invalid_integer
        - validation_error
      description: Machine-readable validation error code.
  securitySchemes:
    OAuth2:
      type: oauth2
      description: >-
        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.
      flows:
        clientCredentials:
          tokenUrl: /oauth/token
          scopes:
            organizations:read: Read organization data
            organizations:write: Create or update organization data
            organizations:*: Full access to organization data
            distributions:read: Read distribution data
            distributions:write: Create or update distributions
            distributions:*: Full access to distributions
            vehicles:read: Read vehicle data
            vehicles:write: Create or update vehicles
            vehicles:*: Full access to vehicles
            entities:read: Read entity data
            entities:write: Create or update entities
            entities:*: Full access to entities
            contacts:read: Read contact data
            contacts:write: Create or update contacts
            contacts:*: Full access to contacts

````