getBuild

Returns build metadata for a specific app build.

Request

GET /v1/getBuild?appId={appId}&buildId={buildId}
Authorization: Bearer <access-token>

Query Parameters

ParameterTypeRequiredDescription
appIdstringYesThe ToDesktop app ID.
buildIdstringYesThe build ID to fetch.

Headers

HeaderRequiredDescription
AuthorizationYesMust be set to Bearer <access-token>.

Authorization Rules

The supplied access token must belong to:

  • the owner of the app, or
  • a user who has accepted access to apps owned by that account

Response

This endpoint returns the stored build metadata object for the requested build. The exact shape depends on the build record stored in ToDesktop.

{
  "id": "240229r7vjixpjp",
  "appVersion": "1.2.3",
  "releasedAt": "2024-02-29T12:34:56.000Z"
}

Example

curl \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  "https://api.todesktop.com/v1/getBuild?appId=your-app-id&buildId=your-build-id"

Errors

  • 400 if appId or buildId is missing.
  • 401 with { "error": "Missing or invalid Authorization header" } when the bearer token is missing or malformed.
  • 401 with { "error": "Invalid access token" } when the token is invalid.
  • 403 with { "error": "Unauthorized" } when the authenticated user cannot access the app.
  • 404 if the user, app, or build cannot be found.