Skip to content

List all pending invitations for a group

GET
/api/v4/groups/{id}/invitations

Lists all pending invitations for a specified group viewable by the authenticated user. Returns invitations to direct members only, and not through inherited ancestor groups. This function takes pagination parameters page and per_page to restrict the list of members.

id
required
string

The group ID

page
integer
default: 1 nullable

Current page number

Example
1
per_page
integer
default: 20 nullable

Number of items per page

Example
20
query
string
nullable

A query string to search for members

OK

Media type application/json
object
access_level
string
created_at
string
expires_at
string
invite_email
string
invite_token
string
user_name
string
created_by_name
string
Example generated
{
"access_level": "example",
"created_at": "example",
"expires_at": "example",
"invite_email": "example",
"invite_token": "example",
"user_name": "example",
"created_by_name": "example"
}

Bad Request

Not Found