Skip to main content
Requests

List assessments in a window

GET
/assessments
Authorizationstringheaderrequired

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

limitintegerquerydefault:25
Required range: 1 <= x <= 100
cursorstringquery
include_totalenum<string>querydefault:false

When true, total is a full count of matching records and costs an extra query. Otherwise total is null.

Available options: true, false
start_datestringqueryrequired
end_datestringqueryrequired
user_idstringquery

Response

application/json

Live assessments of unarchived requests overlapping [start_date, end_date), earliest first. The window is at most 92 days.

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

data(object | null)[]required
has_morebooleanrequired
next_cursorstring | nullrequired
previous_cursorstring | nullrequired
totalinteger | nullrequired

Null unless include_total=true.

Required range: 0 <= x