Skip to main content
GET
cURL

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Query Parameters

trashed
boolean
default:false
type
enum<string>
default:all
Available options:
all,
resume,
letter
q
string
default:""
Maximum string length: 500
tags
string[]
Maximum array length: 20
Required string length: 1 - 40
public
boolean
default:false
sort
enum<string>
default:edited
Available options:
edited,
name,
created
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

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
isPublic
boolean
required

Whether a resume's public link is on; always false for letters.

hasPassword
boolean
required

Whether a resume has a password set. Visitors need it while the resume is public (isPublic); always false for letters.

slug
string | null
required

A resume's public address, /{username}/{slug}; null for letters.

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

When anything about the document last changed, its details included.

editedAt
string<date-time>
required

When its content was last edited: a resume's data, or a letter's text, recipient and design. Renames, tags, sharing, locks and Trash don't move it. Library sorting by edited uses it.

recipient
string | null
required

Who a letter is to: its recipient company, else the recipient's name. Null for resumes and blank letters.

application
object | null
required

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