Skip to main content
GET
List invitations

Authorizations

Authorization
string
header
required

Use API-Key YOUR_API_KEY. The key selects the Production or Development environment.

Path Parameters

studyId
string<uuid>
required

Query Parameters

status
enum<string>
required

Returns only the invitations in this state. OPEN invitations can still be answered, SPENT invitations already carry a response, and EXPIRED invitations are past the Study close date. A Study that allows unlimited responses per invitation never has SPENT invitations.

Available options:
OPEN,
SPENT,
EXPIRED
limit
integer
default:50

How many invitations to return per page.

Required range: 1 <= x <= 50
cursor
string

The cursor returned by the previous page. Omit it to read the first page.

Maximum string length: 999

Response

Invitations returned.

A cursor-paginated page of Study invitations.

data
object[]
required
cursor
string | null
required

Opaque cursor for the next page, or null when this is the final page.