PApactima
Invitations

List all invitations

List all invitations for the specified participant pool

get/participant-pools/{participantPoolId}/invitations

Request

  • Base URL
    https://rest.api.pactima.com/v1
  • URL
    https://rest.api.pactima.com/v1/participant-pools/{participantPoolId}/invitations
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum number of invitations to return

skipinteger

Number of invitations to skip

status'PENDING' | 'DECLINED'

Lifecycle status of a participant pool invitation. Absent on invitations created before this field existed; consumers must treat a missing value as PENDING.

Filter invitations by status. A missing status on an invitation counts as PENDING.

Response

A directory with a data property that contains an array of up to limit invitations, starting after skip. When the status filter is used, total and hasMore reflect the filtered set. Each entry in the array is a separate invitation object. If no more invitations are available, the resulting array will be empty. This request should never return an error.

hasMoreboolean

Indicates if there are more invitations to fetch

totalinteger

Total number of invitations

Changes

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