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

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

tagsstring · string[]#

Default: []

sortenum<string>#

Default: "lastUpdatedAt"

Options:lastUpdatedAtcreatedAtname

Responses

application/json
A list of resumes with their metadata (without full resume data).
idstringrequired#
The ID of the resume.
namestringrequired#
The name of the resume.

Length: min 1

slugstringrequired#
The slug of the resume.

Length: min 1

tagsstring[]required#
The tags of the resume.
isPublicbooleanrequired#
Whether the resume is public.
showDownloadButtonsbooleanrequired#
Whether download buttons are shown on the public resume page.
showInSearchEnginesbooleanrequired#
Whether search engines may list the resume's public web page. Off unless the owner turns it on.
hideContactDetailsbooleanrequired#
Whether the public web page, its PDF and this API leave out the email, phone, location, custom header fields and references' phone numbers.
isPrimarybooleanrequired#
Whether this is the account's primary resume, opened by its short link and custom domain.
isLockedbooleanrequired#
Whether the resume is locked.
createdAtstringrequired#
The date and time the resume was created.
updatedAtstringrequired#
The date and time the resume was last updated.