API Reference

List workflow runs

get
https://api.joinpopp.com/v1/workflows//runs

Returns a paginated list of runs for the given workflow. Filter by status, candidate profile, and/or candidate name. Each run carries the candidate's name as recorded at enrolment time, so listing runs does not require a follow-up call per run to resolve the candidate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Identifier of the workflow.

Query Params
integer

Maximum number of runs to return per page.

string

Pagination cursor returned by the previous call.

string

Comma-separated list of statuses to filter by. Allowed values: RUNNING, COMPLETED, FAILED, CANCELLED. Example: RUNNING,COMPLETED.

uuid

Filter to runs for the given candidate profile.

string
length ≥ 1

Filter to runs whose candidate name matches this phrase. Matches an ordered sequence of words against the candidate name recorded on the run, so John Smith matches John Smith but not Smith John, and John matches every candidate named John. Case-insensitive. Combine with nextToken to page the filtered result.

Responses

Updated 5 months 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 5 months ago

Did this page help you?