SHshorebird
organizations

List organizations the current user is a member of.

A request from the Shorebird CLI (one carrying x-cli-version) by a person who belongs to no organization first creates one for them, named after their email, so shorebird init has somewhere to put the app. Any other caller gets an empty list and creates one with POST /organizations.

get/organizations

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.

pageinteger

The 1-based number of the page to return, on a list whose response carries total_count. Like per_page, sending it opts in to pagination. Send either page or cursor, not both (400, invalid_page). A value that is not a positive integer reads the first page.

Response

The organizations the user is a member of.

next_cursorstring

The opaque cursor of the next page; send it back as cursor to get that page. Present only when the request was paginated (sent per_page, cursor or page) and another page follows. Absent on the last page and on unpaginated responses.

total_countinteger

How many items the whole list holds. Present only when the request was paginated.

Changes

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