API Reference

Get a candidate list by external ID

get
https://api.joinpopp.com/v1/candidates/lists/by-external-id/

Returns the candidate list in the caller's organization with the given external ID, together with a page of its members. Members are paginated with limit + nextToken. Returns 404 when no list matches.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 256
^[\w.-]+$

Caller-supplied external identifier matching ^[\w.-]+$ (1-256 characters).

Query Params
integer
1 to 50

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

string

Pagination token for members returned by a previous call.

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?