SHshorebird
enterprises

List an enterprise's members.

Admins first, then by email: those it has not removed, or with removed=true those it has. Each carries the organizations they are in and their grants on single apps, and the page carries those organizations and apps. member_count and removed_count count both lists, whichever the page is from. Admins only.

get/enterprises/{enterpriseId}/members

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' | 'account' | '-account' | 'role' | '-role' | 'last_sign_in' | '-last_sign_in' | 'last_active' | '-last_active' | 'removed' | '-removed' | 'removed_by' | '-removed_by'

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).

removedboolean

List the members the enterprise has removed instead.

Response

One page of members.

total_countinteger required

How many items the whole list holds.

next_cursorstring

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

member_countinteger required

How many members it has not removed.

removed_countinteger required

How many members it has removed.

Changes

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