---
updatedAt: 2026-04-21T15:00:01.000Z
agentTools:
  projectIndex: https://developer.zylo.com/llms.txt
---

# Get Report Jobs

### Required Permissions
`admin`
### 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)))$"
      },
      "NumberFilter": {
        "type": "string",
        "example": "100,gte,200,lt",
        "description": "Valid number filter format",
        "pattern": "^^([0-9]{1,}([.][0-9]{0,})?,(gt|gte),([0-9]{1,}([.][0-9]{0,})?,(lt|lte)))$|^([0-9]{1,}([.][0-9]{0,})?,(lt|gt|gte|lte))$"
      },
      "JsonApiResponse": {
        "properties": {},
        "additionalProperties": {},
        "type": "object"
      },
      "ReportJobs": {
        "properties": {
          "error_message": {
            "type": "string",
            "nullable": true,
            "description": "The error message associated with the report job, if any."
          },
          "id": {
            "$ref": "#/components/schemas/UUID"
          },
          "query": {
            "allOf": [
              {
                "$ref": "#/components/schemas/JsonApiResponse"
              }
            ],
            "nullable": true,
            "description": "The query used to generate the report."
          },
          "rows": {
            "type": "number",
            "format": "double",
            "nullable": true,
            "description": "The number of rows in the generated report."
          },
          "status": {
            "type": "string",
            "enum": [
              "P",
              "C",
              "E"
            ],
            "description": "The current status of the report job. \"E\" - The job has errored and will be not be available for download. \"P\" - The job is currently processing. \"C\" - The job has completed and is available for download."
          },
          "zylo_created_at": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateTime"
              }
            ],
            "nullable": true,
            "description": "Date and time the record was created in Zylo."
          },
          "zylo_modified_at": {
            "allOf": [
              {
                "$ref": "#/components/schemas/DateTime"
              }
            ],
            "nullable": true,
            "description": "Date and time the record was last modified in Zylo."
          }
        },
        "required": [
          "error_message",
          "id",
          "query",
          "rows",
          "status",
          "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/reports/jobs": {
      "get": {
        "operationId": "ReportingController_GetReportJobs",
        "responses": {
          "200": {
            "description": "Ok",
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/ReportJobs"
                  },
                  "type": "array"
                }
              }
            }
          }
        },
        "description": "### Required Permissions\n`admin`\n### Rate Limit\n`basic`",
        "summary": "Get Report Jobs",
        "tags": [
          "Reports API"
        ],
        "security": [
          {
            "apiKey": []
          }
        ],
        "parameters": [
          {
            "description": "The error message associated with the report job, if any.",
            "in": "query",
            "name": "error_message",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "id",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/UUID"
            }
          },
          {
            "description": "The number of rows in the generated report.",
            "in": "query",
            "name": "rows",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/NumberFilter"
            }
          },
          {
            "description": "The current status of the report job. \"E\" - The job has errored and will be not be available for download. \"P\" - The job is currently processing. \"C\" - The job has completed and is available for download.",
            "in": "query",
            "name": "status",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "P",
                "C",
                "E"
              ]
            }
          },
          {
            "description": "Date and time the record was created in Zylo.",
            "in": "query",
            "name": "zylo_created_at",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/DateFilter"
            }
          },
          {
            "description": "Date and time the record was last modified in Zylo.",
            "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": "Reports API"
    }
  ]
}
```