invitations_list

GET

/a/{team_slug}/team/api/invitations/

const url = 'https://example.com/a/example/team/api/invitations/';
const options = {method: 'GET', headers: {cookie: 'sessionid=<sessionid>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/a/example/team/api/invitations/ \
  --cookie sessionid=<sessionid>

Authorizations

cookieAuth
ApiKeyAuth

Parameters

Path Parameters

team_slug

required

string

Query Parameters

page

integer

A page number within the paginated result set.

Responses

200

application/json

object

count

required

integer

next

string format: uri

nullable

previous

string format: uri

nullable

results

required

Array<object>

object

required

string format: uuid

team

required

integer

email

required

string format: email

<= 254 characters

role

admin - Administrator
member - Member

string

Allowed values: admin member

invited_by

required

string

is_accepted

boolean

Example

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "role": "admin"
    }
  ]
}