Sign in
Items

List pool items

Returns a paginated list of items in the participant pool

get/participant-pools/{participantPoolId}/items

Query parameters

limitinteger

Maximum number of items to return

skipinteger

Number of items to skip

status'DRAFT' | 'AWAITING_TAGGING' | 'AWAITING_PARTICIPANT_PREFERENCE' | 'REQUEST_SENT_TO_ENROLLEES' | 'MATCHED' | 'STALE' | 'CANCELLED' | 'COMPLETED'

Current status of a participant pool item

Filter items by status

startDatestring date-time

Filter items by start date range (inclusive)

endDatestring date-time

Filter items by end date range (inclusive)

Response

A directory with a data property that contains an array of up to limit items, starting after skip. Each entry in the array is a separate item object. If no more items are available, the resulting array will be empty. This request should never return an error.

hasMoreboolean

Indicates if there are more items to fetch

totalinteger

Total number of items matching the filter criteria

Changes

No recorded changes to this endpoint across all 1 revision of this API.