Invitations
Search for invitations
Search and filter invitations by email, status, and pagination.
get/api/v1/{tenant}/invitations/search
Request
- Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
- URL: /api/v1/{tenant}/invitations/search
- Auth: one of:
- HTTP bearer
- HTTP basic
Path parameters
tenantstring required
Query parameters
emailstring nullable
The email address of the invited
status'PENDING' | 'ACCEPTED' | 'EXPIRED'
The current status of the invitations
pageinteger required
The current page
sizeinteger required
The current page size
sortstring[] nullable
The sort of current page
Response
searchInvitations 200 response
Example response
{
"results": [
{
"roles": [
{
"isDefault": true,
"name": "name",
"id": "id",
"isManaged": true
}
],
"groups": [
{
"name": "name",
"id": "id"
}
]
}
]
}Changes
No recorded changes to this operation across all 7 revisions of this API.