Skip to main content
GET
cURL
Lists the pending invites of the workspace: people who were invited by email and have not joined yet. Use the email query parameter to look up a single invite by email; an unknown email returns an empty list.

Authorizations

X-Claap-Key
string
header
required

Query Parameters

cursor
string

Paginate the results starting at the cursor returned by a previous call. Pages may contain fewer than "limit" results; iterate until no nextCursor is returned.

email
string<email>

Return only the invite for this email. When provided, cursor and limit are ignored. An unknown email returns an empty list.

limit
number
default:20

Return at most "limit" results.

Required range: 1 <= x <= 100

Response

Invites were successfully retrieved

result
object
required