SHshorebird
organizations

List an organization's pending invitations.

Invitations to join the organization that are still pending, most recently sent first. Accepted, declined, revoked and expired invitations are left out. Requires the invitations.view permission, which every role except auditor holds.

get/organizations/{organizationId}/invitations

Request

  • Base URL
    https://api.shorebird.dev/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

per_pageinteger

The number of items per page. Sending per_page (or cursor) opts in to pagination: the response holds one page and, unless it is the last, a next_cursor body field. Without either, the full list is returned with no next_cursor. Values above 100 are treated as 100; values that are not a positive integer are treated as 30.

cursorstring

The next_cursor of the previous page, which this page starts after. Send it with the same other query parameters as the previous request. It is opaque: do not build or parse it. An unreadable cursor is a 400.

Response

One page of the organization's pending invitations.

next_cursorstring

The opaque cursor of the next page; send it back as cursor to get that page. Absent on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.