Skip to main content
GET
/
resumes
List all resumes
curl --request GET \
  --url http://localhost:3000/api/openapi/resumes \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "tags": [
      "<string>"
    ],
    "isPublic": true,
    "isLocked": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

The API key to authenticate requests.

Query Parameters

​
tags
string[]
​
sort
enum<string>
default:lastUpdatedAt
Available options:
lastUpdatedAt,
createdAt,
name

Response

200 - application/json

A list of resumes with their metadata (without full resume data).

​
id
string
required

The ID of the resume.

​
name
string
required

The name of the resume.

Required string length: 1 - 64
​
slug
string
required

The slug of the resume.

Required string length: 1 - 64
​
tags
string[]
required

The tags of the resume.

​
isPublic
boolean
required

Whether the resume is public.

​
isLocked
boolean
required

Whether the resume is locked.

​
createdAt
string<date-time>
required

The date and time the resume was created.

​
updatedAt
string<date-time>
required

The date and time the resume was last updated.