API Reference

List candidate lists

get
https://api.joinpopp.com/v1/candidates/lists

Returns the candidate lists in the caller's organization, most recently created first. Paginated with limit + nextToken, and filterable by title and/or externalId. To fetch a single list by external id, prefer GET /v1/candidates/lists/by-external-id/{externalId}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 50

Maximum number of items per page (1-50). Defaults to 20.

string

Pagination token returned by a previous call.

string

Filter to lists whose title contains this value (case-sensitive substring).

string
^[\w.-]+$

Filter to the list with this exact external id.

string
enum

Sort direction by creation date. Defaults to DESC.

Allowed:
Responses

Updated 2 days ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

Did this page help you?