GET
Get resume by ID

Authorizations

x-api-key
string
header
required

An API key from Settings → Developers → API keys in Hiresweep.

Path Parameters

id
string
required

The ID of the resume.

Response

200 - application/json

The resume with its full data.

id
string
required

The ID of the resume.

name
string
required

The name of the resume.

Minimum string length: 1
slug
string
required

The slug of the resume.

Minimum string length: 1
tags
string[]
required

The tags of the resume.

target
string | null
required

The job or company this resume is tailored for, shown on dashboard cards; null for a general resume.

Maximum string length: 120
isPublic
boolean
required

Whether the resume is public.

isLocked
boolean
required

Whether the resume is locked.

data
object
required
clientId
string | null
required

The client this resume belongs to, for an operator applying on behalf of clients; null for your own.

updatedAt
string<date-time>
required

The date and time the resume was last updated.

hasPassword
boolean
required