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

Uses the shared API authentication rules. The caller must own the app or be a collaborator with current, accepted app access. Read-only access is sufficient.

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",
  "customLabels": {
    "qa": {
      "text": "Smoke tests passed",
      "color": "green"
    }
  }
}

When present, customLabels contains the label map stored on the build. Builds without stored labels omit the field. See getBuildLabels for its schema and a response that always includes a label map.

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 or invalid.
  • 404 if the app or build cannot be found.

For authentication and permission errors, see the shared error handling reference.