Skip to content

Retrieve a page of anonymised candidates in a saved list

Request

Fetches a paginated array of anonymised candidates belonging to a specific saved list, identified by its public ID.

Security
ApiKeyAuth
Path
publicListIdstringrequired

The public ID of the saved list

Query
pageinteger, >= 0

The page number for pagination

Default:0
limitinteger, [ 1 .. 100 ]

The number of results per page

Default:10
curl -i -X GET \
  'https://tc-api.redocly.app/_mock/openapi/v1/candidates/by-list/{publicListId}?page=0&limit=10' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

A page of anonymised candidates

Bodyapplication/json
contentArray of objects(Candidate)
totalElementsinteger
totalPagesinteger
sizeinteger
numberinteger
Response
{
  "content": [
    { … }
  ],
  "totalElements": 0,
  "totalPages": 0,
  "size": 0,
  "number": 0
}