getReleaseBuildIds

Returns the full and partial releases for a given app.

Request

GET /v1/getReleaseBuildIds?appId={appId}

Query Parameters

ParameterTypeRequiredDescription
appIdstringYesThe ToDesktop app ID.

Response

Successful responses return released builds in descending release timestamp order. Full releases are ordered by releasedAt; partial-only releases are ordered by partiallyReleasedAt.

{
  "releases": [
    {
      "buildId": "240229r7vjixpjp",
      "version": "1.2.3",
      "releaseType": "full",
      "isCurrentlyPartial": false,
      "releasedAt": "2024-02-29T12:34:56.000Z"
    },
    {
      "buildId": "240301avx8eb63",
      "version": "1.2.4",
      "releaseType": "partial",
      "isCurrentlyPartial": true,
      "partiallyReleasedAt": "2024-03-01T09:10:11.000Z"
    }
  ],
  "count": 2
}

Response Fields

FieldTypeDescription
releasesArray<{ buildId: string; version: string; releaseType: 'full' | 'partial'; isCurrentlyPartial: boolean; releasedAt?: string; partiallyReleasedAt?: string }>The released builds for the app.
countnumberThe number of released builds returned.

Each item in releases includes:

FieldTypeDescription
buildIdstringThe released build ID.
versionstringThe app version for the build.
releaseType'full' | 'partial'full when releasedAt exists; otherwise partial when only partiallyReleasedAt exists.
isCurrentlyPartialbooleantrue when the build is still targeted by an active buildByIp or buildByPlatform release redirection.
releasedAtstringThe full release timestamp, when the build has been fully released.
partiallyReleasedAtstringThe partial release timestamp, when the build has been partially released.

Example

curl "https://api.todesktop.com/v1/getReleaseBuildIds?appId=your-app-id"

Errors

  • 400 if appId is missing.
  • 404 with { "message": "No released builds found" } when the app has no released builds.
Previous getReleaseStatus
Next getBuild