---
title: "AvailableUplineV2Page"
url: "https://developer.agentsync.io/apis/contracting-hierarchies-api/versions/40f58935-396e-4da4-8f47-1587041e1b16/schemas/AvailableUplineV2Page"
---

> Full API specification: https://developer.agentsync.io/apis/contracting-hierarchies-api/versions/40f58935-396e-4da4-8f47-1587041e1b16.md

# AvailableUplineV2Page

A token-paginated page of available upline candidates (plain envelope, no HAL wrappers).

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: AgentSync Contracting & Hierarchies API
  version: v1.7.6
servers:
  - url: https://api.sandbox.agentsync.io/contracting
    description: Sandbox
  - url: https://api.agentsync.io/contracting
    description: Production
components:
  schemas:
    AvailableUplineV2:
      type: object
      description: A currently-approved contract assignment eligible to be selected as
        an upline.
      properties:
        contractAssignmentId:
          type: string
          format: uuid
        firstName:
          type: string
        lastName:
          type: string
        suffix:
          type: string
        firmId:
          type: string
          format: uuid
        firmName:
          type: string
          description: The candidate's firm name, if the candidate is a firm.
        personId:
          type: string
          format: uuid
        npn:
          type: string
        writingNumber:
          type: string
        levelOfCommission:
          type: number
        annualizationProportion:
          type: number
        productId:
          type: string
          format: uuid
        testAccount:
          type: boolean
        commissionLevelName:
          type: string
      required:
        - contractAssignmentId
    PageInfo:
      type: object
      description: Pagination metadata for a V2 list response.
      properties:
        size:
          type: integer
          description: Number of items returned in this response (equal to items.length).
        nextToken:
          type:
            - string
            - "null"
          description: Opaque continuation token for the next page, or null on the last
            page.
      required:
        - size
        - nextToken
    AvailableUplineV2Page:
      type: object
      description: A token-paginated page of available upline candidates (plain
        envelope, no HAL wrappers).
      properties:
        items:
          type: array
          items:
            $ref: "#/components/schemas/AvailableUplineV2"
        page:
          $ref: "#/components/schemas/PageInfo"
      required:
        - items
        - page
```