Skip to main content
get/resumes/{resumeId}/slug-check
Request example
Response
get/resumes/{resumeId}/slug-check

Authorization

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

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

Path parameters

resumeIdstringrequired#
The ID of the resume the slug is for.

Query parameters

slugstringrequired#
The slug to check.

Responses

application/json
Whether the slug is available, and a suggestion when it isn't.
statusenum<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.
Options:availablecurrentinvalidtaken
takenBystring#
The name of the resume that uses the slug, when taken.
suggestionstring#
A slug that would work instead.