Get a candidate list 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
string
length between 1 and 255

Your own identifier for the organization to look in, instead of the one x-organization-id names. Resolved within your organization group and checked against the access of the user the API key belongs to. Unknown or ambiguous values return 400, an organization the user cannot reach 403.

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

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