Skip to main content
get/documents
Request example
Response
get/documents

Authorization

x-api-keystringheaderrequired#
The API key to authenticate requests.

2 alternative authorization methods available — see the spec for details.

Query parameters

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

Range: 1–100

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

Range: 0–9007199254740991

trashedboolean#
List the documents in Trash instead.

Default: false

Responses

application/json
OK
typeenum<string>required#
resume, or letter (a saved cover letter).
Options:resumeletter
idstringrequired#
namestringrequired#
tagsstring[]required#
isLockedbooleanrequired#
isPublicbooleanrequired#
Whether a resume's public link is on; always false for letters.
slugstring · nullrequired#
A resume's public address, /{username}/{slug}; null for letters.
trashedAtstring · nullrequired#
When the document moved to Trash; null while it's live.
createdAtstringrequired#
updatedAtstringrequired#
applicationobject · nullrequired#
The job application this document was made for, if any.