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

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

# ContractV2Page

A token-paginated page of contracts (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:
    ContractV2:
      type: object
      description: A contract sent from an agency to a carrier on behalf of a producer.
      properties:
        id:
          type: string
          format: uuid
          description: The contract id.
        agencyOrganizationId:
          type: string
          format: uuid
          description: The agency organization the contract is sent from.
        carrierOrganizationId:
          type: string
          format: uuid
          description: The carrier organization the contract is sent to.
        personId:
          type: string
          format: uuid
          description: The individual producer the contract is on behalf of.
        firmId:
          type: string
          format: uuid
          description: The firm the contract is on behalf of, if any.
        responsibleUplineFirmId:
          type: string
          format: uuid
          description: The upline firm responsible for the contract, if any.
        assignmentStatusId:
          type: string
          format: uuid
          description: The contract's assignment status id.
        assignmentStatusName:
          type: string
          description: The human-readable assignment status (inlined so no follow-up
            lookup is needed).
        active:
          type: boolean
          description: Whether the contract is currently active based on its assignments.
        effectiveDate:
          type: string
          format: date
          description: The effective date of the contract (yyyy-MM-dd).
        endDate:
          type: string
          format: date
          description: The end date of the contract (yyyy-MM-dd).
        displayNumber:
          type: string
          description: The human-readable contract number.
        parentContractId:
          type: string
          format: uuid
          description: The parent contract id, if this is a subsidiary contract.
        contractResponsibleParties:
          type: array
          description: >
            The contract's responsible-party windows, ordered by `startDate`
            ascending. An empty array

            when the contract has no responsible party.


            This is the contract's full responsible-party history, which is
            expected to stay small (a

            handful of windows per contract) and is embedded rather than
            paginated.
          items:
            $ref: "#/components/schemas/ContractResponsiblePartyV2"
        createdAt:
          type: string
          format: date-time
          description: RFC3339 UTC creation timestamp.
        updatedAt:
          type: string
          format: date-time
          description: RFC3339 UTC last-modified timestamp.
        userDefined1:
          type: string
        userDefined2:
          type: string
        userDefined3:
          type: string
        userDefined4:
          type: string
        userDefined5:
          type: string
        userDefined6:
          type: string
        userDefined7:
          type: string
        userDefined8:
          type: string
        userDefined9:
          type: string
        userDefined10:
          type: string
      required:
        - id
        - agencyOrganizationId
        - carrierOrganizationId
        - personId
        - active
        - displayNumber
        - contractResponsibleParties
    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
    ContractResponsiblePartyV2:
      type: object
      description: >
        One responsible-party window on a contract. Both bounds are inclusive.
        Windows do not overlap, with

        two exceptions: two windows may meet on a single shared day (one
        window's `endDate` equal to the

        next window's `startDate`), and a window whose `startDate` equals its
        `endDate` is a retired record

        rather than a live one-day assignment. To resolve who is responsible on
        a given day, ignore windows

        where `startDate` equals `endDate`, and on a shared boundary day prefer
        the window that starts that

        day over the one that ends it. The current window is the one with no
        `endDate`; there is at most one

        per contract.
      properties:
        id:
          type: string
          format: uuid
          description: The responsible-party window id.
        responsiblePartyId:
          type: string
          format: uuid
          description: The person responsible for the contract during this window.
        startDate:
          type: string
          format: date
          description: The first day the responsible party is responsible (yyyy-MM-dd).
        endDate:
          type:
            - string
            - "null"
          format: date
          description: >
            The last day the responsible party is responsible (yyyy-MM-dd).
            Absent on the current,

            open-ended window.
      required:
        - id
        - responsiblePartyId
        - startDate
    ContractV2Page:
      type: object
      description: A token-paginated page of contracts (plain envelope, no HAL wrappers).
      properties:
        items:
          type: array
          items:
            $ref: "#/components/schemas/ContractV2"
        page:
          $ref: "#/components/schemas/PageInfo"
      required:
        - items
        - page
```