---
updatedAt: 2026-05-08T17:32:21.000Z
agentTools:
  projectIndex: https://developer.zylo.com/llms.txt
---

# Get Company Documents

Retrieve a list of company documents. Company documents are created
when files are uploaded through the Pending Contracts upload endpoints,
attached to contracts, or imported from external systems such as Coupa.
Use the `status` query parameter to filter by processing status:
`U` (uploading — file received, AI extraction in progress),
`A` (active — extraction complete, data available in Pending Contracts),
or `E` (error — extraction failed).

### Required Permissions
`applications:read AND 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)))$"
      },
      "CompanyDocuments": {
        "properties": {
          "byte_size": {
            "type": "string",
            "nullable": true,
            "description": "File size in bytes."
          },
          "content_type": {
            "type": "string",
            "nullable": true,
            "description": "MIME type of the uploaded file (e.g., application/pdf, image/jpeg)."
          },
          "description": {
            "type": "string",
            "nullable": true,
            "description": "Description of the uploaded document."
          },
          "external_document_id": {
            "type": "string",
            "nullable": true,
            "description": "External ID for the document if fetched from an external system (e.g., Coupa)."
          },
          "filename": {
            "type": "string",
            "nullable": true,
            "description": "Name of the uploaded file."
          },
          "id": {
            "$ref": "#/components/schemas/UUID",
            "description": "Unique identifier for the company document."
          },
          "status": {
            "type": "string",
            "enum": [
              "U",
              "A",
              "E"
            ],
            "description": "Processing status of the document. U = Uploading, A = Active (processed), E = Error."
          },
          "zylo_created_at": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateTime"
              }
            ],
            "nullable": true,
            "description": "Date and time the document was created."
          },
          "zylo_modified_at": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateTime"
              }
            ],
            "nullable": true,
            "description": "Date and time the document was last modified."
          },
          "zylo_user_id": {
            "allOf": [
              {
                "$ref": "#/components/schemas/UUID"
              }
            ],
            "nullable": true,
            "description": "Unique identifier for the Zylo user who created this document."
          }
        },
        "required": [
          "byte_size",
          "content_type",
          "description",
          "external_document_id",
          "filename",
          "id",
          "status",
          "zylo_created_at",
          "zylo_modified_at",
          "zylo_user_id"
        ],
        "type": "object",
        "additionalProperties": true
      }
    },
    "securitySchemes": {
      "apiKey": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "info": {
    "title": "Resources",
    "version": "2.0.0"
  },
  "paths": {
    "/v2/companyDocuments": {
      "get": {
        "operationId": "CompanyDocumentsController_GetCompanyDocuments",
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/CompanyDocuments"
                  },
                  "type": "array"
                }
              }
            }
          }
        },
        "description": "Retrieve a list of company documents. Company documents are created\nwhen files are uploaded through the Pending Contracts upload endpoints,\nattached to contracts, or imported from external systems such as Coupa.\nUse the `status` query parameter to filter by processing status:\n`U` (uploading — file received, AI extraction in progress),\n`A` (active — extraction complete, data available in Pending Contracts),\nor `E` (error — extraction failed).\n\n### Required Permissions\n`applications:read AND contracts:read`\n### Rate Limit\n`basic`",
        "summary": "Get Company Documents",
        "tags": [
          "Company Documents"
        ],
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "description": "File size in bytes.",
            "in": "query",
            "name": "byte_size",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "MIME type of the uploaded file (e.g., application/pdf, image/jpeg).",
            "in": "query",
            "name": "content_type",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Description of the uploaded document.",
            "in": "query",
            "name": "description",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "External ID for the document if fetched from an external system (e.g., Coupa).",
            "in": "query",
            "name": "external_document_id",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Name of the uploaded file.",
            "in": "query",
            "name": "filename",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Unique identifier for the company document.",
            "in": "query",
            "name": "id",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          },
          {
            "description": "Processing status of the document. U = Uploading, A = Active (processed), E = Error.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "U",
                "A",
                "E"
              ]
            }
          },
          {
            "description": "Date and time the document was created.",
            "in": "query",
            "name": "zylo_created_at",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/DateFilter"
            }
          },
          {
            "description": "Date and time the document was last modified.",
            "in": "query",
            "name": "zylo_modified_at",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/DateFilter"
            }
          },
          {
            "description": "Unique identifier for the Zylo user who created this document.",
            "in": "query",
            "name": "zylo_user_id",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          },
          {
            "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": "Company Documents"
    }
  ]
}
```