---
updatedAt: 2026-05-22T15:55:23.000Z
agentTools:
  projectIndex: https://developer.zylo.com/llms.txt
---

# Get Pending Contracts

### Required Permissions
`contracts:read`
### Rate Limit
`basic`

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "components": {
    "schemas": {
      "UUID": {
        "type": "string",
        "example": "52907745-7672-470e-a803-a2f8feb52944",
        "description": "Stringified UUIDv4.",
        "pattern": "[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}"
      },
      "DateTime": {
        "type": "string",
        "format": "date-time",
        "description": "Diplays dates as a string in the format \"YYYY-MM-DD HH:MM:SS\"."
      },
      "DateFilter": {
        "type": "string",
        "example": "2022-03-07,gte,2023-03-08,lt",
        "description": "Valid date filter format",
        "pattern": "^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$"
      },
      "DateDay": {
        "type": "string",
        "format": "date",
        "description": "Displays dates as a string in the format \"YYYY-MM-DD\"."
      },
      "PendingContracts": {
        "properties": {
          "billing_frequency": {
            "type": "string",
            "nullable": true,
            "description": "How often billing occurs (e.g., monthly, annually)."
          },
          "cancellation_policy": {
            "type": "string",
            "nullable": true,
            "description": "The cancellation policy for the pending contract."
          },
          "company_document_id": {
            "$ref": "#/components/schemas/UUID",
            "description": "The company document associated with this pending contract."
          },
          "contract_term": {
            "type": "string",
            "nullable": true,
            "description": "Contract term type (Fixed, Auto-renewed, or Perpetual)."
          },
          "created_by": {
            "type": "string",
            "nullable": true,
            "description": "Who uploaded the contract document."
          },
          "end_date": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateDay"
              }
            ],
            "nullable": true,
            "description": "Pending contract end date. May be null for ongoing contracts."
          },
          "id": {
            "$ref": "#/components/schemas/UUID",
            "description": "Unique identifier for the pending contract."
          },
          "is_reviewed": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether the AI-extracted data has been reviewed by a human."
          },
          "month_to_month": {
            "type": "boolean",
            "nullable": true,
            "description": "Whether this is a recurring payment contract."
          },
          "name": {
            "type": "string",
            "nullable": true,
            "description": "Name of the pending contract, typically derived from the uploaded document filename."
          },
          "native_currency": {
            "type": "string",
            "nullable": true,
            "description": "Currency the pending contract was made out for."
          },
          "native_total_contract_value": {
            "type": "string",
            "nullable": true,
            "description": "Estimated total value of the pending contract in native currency."
          },
          "notification_period": {
            "type": "string",
            "nullable": true,
            "description": "Required notification period before contract changes."
          },
          "number": {
            "type": "string",
            "nullable": true,
            "description": "Pending contract number extracted from the document."
          },
          "owner": {
            "type": "string",
            "nullable": true,
            "description": "Person responsible for administering the pending contract."
          },
          "source": {
            "type": "string",
            "nullable": true,
            "description": "The source of the contract data (e.g., API, manual upload)."
          },
          "start_date": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateDay"
              }
            ],
            "nullable": true,
            "description": "Pending contract start date."
          },
          "supplier_id": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UUID"
              }
            ],
            "nullable": true,
            "description": "The supplier associated with this pending contract."
          },
          "zylo_created_at": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateTime"
              }
            ],
            "nullable": true,
            "description": "Date and time the pending contract was created (upload date)."
          },
          "zylo_modified_at": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateTime"
              }
            ],
            "nullable": true,
            "description": "Date and time the pending contract was last modified."
          }
        },
        "required": [
          "billing_frequency",
          "cancellation_policy",
          "company_document_id",
          "contract_term",
          "created_by",
          "end_date",
          "id",
          "is_reviewed",
          "month_to_month",
          "name",
          "native_currency",
          "native_total_contract_value",
          "notification_period",
          "number",
          "owner",
          "source",
          "start_date",
          "supplier_id",
          "zylo_created_at",
          "zylo_modified_at"
        ],
        "type": "object",
        "additionalProperties": true
      }
    },
    "securitySchemes": {
      "apiKey": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "info": {
    "title": "Resources",
    "version": "2.0.0"
  },
  "paths": {
    "/v2/pendingContracts": {
      "get": {
        "operationId": "PendingContractsController_GetPendingContracts",
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/PendingContracts"
                  },
                  "type": "array"
                }
              }
            }
          }
        },
        "description": "### Required Permissions\n`contracts:read`\n### Rate Limit\n`basic`",
        "summary": "Get Pending Contracts",
        "tags": [
          "Contracts"
        ],
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "description": "How often billing occurs (e.g., monthly, annually).",
            "in": "query",
            "name": "billing_frequency",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The cancellation policy for the pending contract.",
            "in": "query",
            "name": "cancellation_policy",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The company document associated with this pending contract.",
            "in": "query",
            "name": "company_document_id",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          },
          {
            "description": "Contract term type (Fixed, Auto-renewed, or Perpetual).",
            "in": "query",
            "name": "contract_term",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Who uploaded the contract document.",
            "in": "query",
            "name": "created_by",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Pending contract end date. May be null for ongoing contracts.",
            "in": "query",
            "name": "end_date",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/DateFilter"
            }
          },
          {
            "description": "Unique identifier for the pending contract.",
            "in": "query",
            "name": "id",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          },
          {
            "description": "Whether the AI-extracted data has been reviewed by a human.",
            "in": "query",
            "name": "is_reviewed",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "description": "Whether this is a recurring payment contract.",
            "in": "query",
            "name": "month_to_month",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "description": "Name of the pending contract, typically derived from the uploaded document filename.",
            "in": "query",
            "name": "name",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Currency the pending contract was made out for.",
            "in": "query",
            "name": "native_currency",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Estimated total value of the pending contract in native currency.",
            "in": "query",
            "name": "native_total_contract_value",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Required notification period before contract changes.",
            "in": "query",
            "name": "notification_period",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Pending contract number extracted from the document.",
            "in": "query",
            "name": "number",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Person responsible for administering the pending contract.",
            "in": "query",
            "name": "owner",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The source of the contract data (e.g., API, manual upload).",
            "in": "query",
            "name": "source",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Pending contract start date.",
            "in": "query",
            "name": "start_date",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/DateFilter"
            }
          },
          {
            "description": "The supplier associated with this pending contract.",
            "in": "query",
            "name": "supplier_id",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          },
          {
            "description": "Date and time the pending contract was created (upload date).",
            "in": "query",
            "name": "zylo_created_at",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/DateFilter"
            }
          },
          {
            "description": "Date and time the pending contract was last modified.",
            "in": "query",
            "name": "zylo_modified_at",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/DateFilter"
            }
          },
          {
            "description": "Sort by any non-object or array value. Use +/- to indicate direction.",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "default": "+zylo_created_at",
              "type": "string"
            },
            "example": "+zylo_created_at"
          },
          {
            "description": "Number of results to bring back.",
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "default": "50",
              "format": "double",
              "type": "number",
              "maximum": 1000
            }
          },
          {
            "description": "Offset the results by this number.",
            "in": "query",
            "name": "skip",
            "required": false,
            "schema": {
              "default": "0",
              "format": "double",
              "type": "number"
            }
          },
          {
            "description": "id value to use cursor based pagination. Can be used in place of skip.",
            "in": "query",
            "name": "cursor",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Search the results by this string.",
            "in": "query",
            "name": "search",
            "required": false,
            "schema": {
              "default": "",
              "type": "string"
            }
          }
        ],
        "x-proxy-enabled": false
      }
    }
  },
  "servers": [
    {
      "url": "https://api.zylo.com/"
    }
  ],
  "tags": [
    {
      "name": "Contracts"
    }
  ]
}
```