Skip to main content
GET
List documents

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Query Parameters

limit
integer

Maximum results (1–100). Omit both pagination fields for the legacy complete list.

Required range: 1 <= x <= 100
offset
integer

Zero-based offset. Defaults to 0; limit defaults to 20 when only offset is given.

Required range: 0 <= x <= 9007199254740991
trashed
boolean
default:false

List the documents in Trash instead.

Response

OK

type
enum<string>
required

resume, or letter (a saved cover letter).

Available options:
resume,
letter
id
string
required
name
string
required
tags
string[]
required
isLocked
boolean
required
trashedAt
string<date-time> | null
required

When the document moved to Trash; null while it's live.

createdAt
string<date-time>
required
updatedAt
string<date-time>
required
application
object | null
required

The job application this document was made for, if any.