Skip to main content
GET
List Requests

Permissions

Requires Intake API permission, and one of Intake requests, Intake access, or Intake admin permission. If these permissions are not available to select, contact support@harvey.ai.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:20

The page size. Values outside the range are clamped rather than rejected.

Required range: 1 <= x <= 100
cursor
string

The pagination.next_cursor from the previous page. Send the same filters with it, since a cursor resumes only the list it was issued for.

status
enum<string>[]

Returns only requests in one of these statuses. Repeat it for several, as in status=TODO&status=IN_PROGRESS. No other parameter may repeat.

Lifecycle state of an intake request.

Available options:
TODO,
IN_PROGRESS,
READY_FOR_REVIEW,
DONE,
CANCELLED
created_after
string<date-time>

Returns only requests created at or after this time. The value must include a UTC offset.

created_before
string<date-time>

Returns only requests created before this time. The value must include a UTC offset.

Response

A page of intake requests, newest first.

requests
object[]

Each request in the same shape a read returns.

pagination
object