Skip to main content
GET
Check a resume address

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Path Parameters

resumeId
string
required

The ID of the resume the slug is for.

Query Parameters

slug
string
required

The slug to check.

Maximum string length: 64

Response

Whether the slug is available, and a suggestion when it isn't.

status
enum<string>
required

available: free to use. current: this resume's slug already. invalid: not lowercase letters, numbers and single dashes. taken: another of the user's resumes uses it.

Available options:
available,
current,
invalid,
taken
takenBy
string

The name of the resume that uses the slug, when taken.

suggestion
string

A slug that would work instead.