---
title: "Request status of the report using jobId"
method: GET
path: "/v1/reports/{jobId}"
tags: ["reports_endpoints"]
deprecated: true
---

# Request status of the report using jobId

`GET /v1/reports/{jobId}`

## Request

- Base URL: `https://partners.tryotter.com`
- URL: `https://partners.tryotter.com/v1/reports/{jobId}`
- Auth: OAuth 2
  - Authorization code: `/v1/auth/oauth2/authorize`
  - Client credentials
  - Token URL: `/v1/auth/token` scopes: `reports.generate_report`
- TypeScript: <https://skmtc.dev/cloudkitchens/apis/otter-api/docs/v1/reports/:jobId/get.ts> (a function with typed inputs; its response is checked against the schema)

> **Deprecated.**

Rate limit: 32 requests per minute.

## Path parameters

- `jobId` string, required: ID used to track the job created for generating report.

## Response `200`

Report is found

- GetReportStatusResponse
  - `status` 'IN_PROGRESS' | 'READY' | 'ERROR' | 'EXPIRED': Report export status
  - `payload` object
    - `reportUrl` string, nullable: URL to download the generated CSV report. It is available only when status is `READY` and can expire; download it promptly.
    - `errorMessage` string, nullable: Error message. It will be available only if status is "ERROR"

## Other responses

- `400`: The request is malformed.
- `401`: Invalid authorization.
- `403`: Authorization not valid for the requested resource.
- `404`: Resource not found.
- `422`: The request body is not valid.

---

[API](https://skmtc.dev/cloudkitchens/apis/otter-api.md) - [All operations](https://skmtc.dev/cloudkitchens/apis/otter-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudkitchens/apis/otter-api/revisions/4c868194a467?raw)