---
title: "List doc requests"
method: GET
path: "/api/v1/doc-requests"
tags: ["authed"]
---

# List doc requests

`GET /api/v1/doc-requests`

## Request

- Base URL: `https://api.teaflask.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.teaflask.com/api/v1/doc-requests`
- Auth: none declared

The review inbox's doc requests, newest first: each asks an agent to
draft a new doc for a member to review. Prompt, status and the drafted
doc's id — read the draft itself with get_doc_request. A full page
means more may exist.

## Query parameters

- `before_created_at` string, date-time, nullable: With before_id: the last row of the previous page's created_at, to read the next page.
- `before_id` string, uuid, nullable: With the sort cursor: the last row of the previous page's id.
- `limit` integer: The most doc requests to return.

## Response `200`

Successful Response

- DocRequestResponse[]
  - `id` string, uuid, required: The doc request's id.
  - `organization_id` string, uuid, required: The organization that owns the request.
  - `prompt` string, required: What the doc was requested to cover.
  - `status` 'queued' | 'working' | 'ready_for_review' | 'approved' | 'dismissed' | 'failed' | 'unfunded', required
  - `error` string, nullable, required: Why the request failed, in a sentence; null unless it failed.
  - `requested_by_user_id` string, uuid, required: The member who asked.
  - `requested_by` string, nullable, required: That member's name, or their email when they have no name.
  - `doc_id` string, uuid, nullable, required: The doc the draft was written into; null until a draft exists.
  - `created_at` string, date-time, required: When the request was made.
  - `updated_at` string, date-time, required: When the request last changed.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `405`: Method not allowed
- `422`: Validation error
- `500`: Internal server error

---

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