SHshorebird
organizations

List apps in an organization.

get/organizations/{organizationId}/apps

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.

qstring

Lists only the apps whose display name contains this text, ignoring case. Applied before paging, so total_count counts the matches.

platform'android' | 'ios' | 'linux' | 'macos' | 'windows'

A platform to which a Shorebird release can be deployed.

Lists only the apps with a release on this platform: those whose platforms holds it. Applied before paging, as q is.

sort'updated' | 'created' | 'name'

What the apps are ordered by, before paging.

direction'asc' | 'desc'

The order of sort. Defaults to asc for name and to desc otherwise, as GitHub's lists do.

Response

The apps belonging to the organization.

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.

platformsReleasePlatform[]

The platforms the listed apps have a release on, across every app the caller may see in the organization, whatever q and platform narrowed the page to. Present only when the request was paginated.

Changes

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