Sign in
invitations

Changed on

A viewset for managing organization invitations.

get/invitations/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Query parameters

emailstring

Filter by partial email match

invited_bynumber

Filter by inviter user ID

is_acceptedboolean

Filter by acceptance status

is_expiredboolean

Filter by expiration status

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Changes