SHshorebird
apps

Get the specified app.

get/apps/{appId}

Request

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

Response

The requested app.

app_idstring required

The ID of the app.

organization_idinteger

The ID of the organization the app belongs to. Every app belongs to exactly one organization and the server always sends this; it is optional only so that clients tolerate servers that predate it.

display_namestring required

The display name of the app.

latest_release_versionstring

The latest release version of the app.

latest_patch_numberinteger

The latest patch number of the app.

created_atstring date-time required

The date and time the app was created.

updated_atstring date-time required

The date and time the app was last updated.

platformsReleasePlatform[]

Every platform the app has shipped to (i.e. has at least one release artifact for). Independent of latest_releases: an app can list a platform here even if no release on that platform has been analyzed yet.

latest_releasesobject

The latest analyzed release per platform. A platform is omitted when no release for that platform has been analyzed yet. When the latest release for a platform is not yet analyzed but a previous one is, the previous release is returned here and pending_releases.{platform} identifies the unanalyzed newer release.

pending_releasesobject

The newest unanalyzed release per platform, whenever one exists. A platform is omitted when its most recent release has already been analyzed. Independent of latest_releases: both can be present (a newer release than the analyzed one is being processed) or only pending_releases can be present (no release on the platform has been analyzed yet).

icon_urlstring

Server-emitted URL for the app's launcher icon, sourced from the most recent analyzed iOS release (or Android, when iOS has no analyzed release with an icon). Requires the same auth as the rest of the apps API. The URL embeds a digest of the icon as a v query parameter so it can be cached indefinitely; a release that leaves the icon unchanged leaves the URL unchanged too. Omitted when no analyzed release has an icon.

Changes

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