SHshorebird
enterprises

List an enterprise's guests.

By email: the people who reach its organizations' apps but are not its members, each flagged when its guest policy would refuse them now. Carries what they reach as the member list does, and outside_guest_policy_count over every guest. Admins only.

get/enterprises/{enterpriseId}/guests

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. These lists always page: without per_page a page holds 30. 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. Opaque. An unreadable cursor is a 400 (invalid_cursor), and sending it with page a 400 (invalid_page).

pageinteger

The 1-based number of the page to read, instead of cursor. A value that is not a positive integer reads the first page.

sort'person' | '-person' | 'last_sign_in' | '-last_sign_in' | 'last_active' | '-last_active'

The column to sort by, ascending, or after a - descending, in place of the list's own order. Rows with no value in the column come last either way. Any other value is a 400 (enterprise_sort_invalid).

Response

One page of guests.

total_countinteger required

How many items the whole list holds.

next_cursorstring

The cursor of the next page; absent on the last page.

outside_guest_policy_countinteger required

How many guests the policy would refuse now.

Changes

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