Apps
List apps
GET/api/v1/apps
Apps with at least one ready, unexpired file, newest first. Any role.
Query parameters
platformstringOnly files for this platform.
qstringCase-insensitive substring of the name, filename or bundle id.
limitintegerPage size, 1 to 100. Default 25.
cursorstring`nextCursor` from the previous page. Opaque.
Header parameters
X-Organization-IdstringSelects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
objectstringrequireddataarrayrequiredShow child attributes
idstring · uuidrequiredplatformstringrequiredbundleIdstringrequirednamestringrequirednullableLabel of the latest file that had one.
iconUrlstringrequirednullableRelative URL of the icon (getAppIcon); null when no icon could be extracted.
fileCountintegerrequiredReady, unexpired files.
latestFileobjectrequirednullableNewest ready file, whoever uploaded it and whatever its branch. Null only when every file has expired.
Show child attributes
idstring · uuidrequirednamestringrequiredversionstringrequirednullablebuildNumberstringrequirednullablecreatedAtstring · date-timerequiredexpiresAtstring · date-timerequiredcreatedAtstring · date-timerequiredupdatedAtstring · date-timerequirednextCursorstringPass as `cursor` for the next page. Absent on the last page.
Get an app
GET/api/v1/apps/{appId}
Any role. An app whose files have all expired is still returned, with fileCount: 0 and latestFile: null.
Path parameters
appIdstring · uuidrequiredApp UUID
Header parameters
X-Organization-IdstringSelects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
idstring · uuidrequiredplatformstringrequiredbundleIdstringrequirednamestringrequirednullableLabel of the latest file that had one.
iconUrlstringrequirednullableRelative URL of the icon (getAppIcon); null when no icon could be extracted.
fileCountintegerrequiredReady, unexpired files.
latestFileobjectrequirednullableNewest ready file, whoever uploaded it and whatever its branch. Null only when every file has expired.
Show child attributes
idstring · uuidrequirednamestringrequiredversionstringrequirednullablebuildNumberstringrequirednullablecreatedAtstring · date-timerequiredexpiresAtstring · date-timerequiredcreatedAtstring · date-timerequiredupdatedAtstring · date-timerequiredList an app's files
GET/api/v1/apps/{appId}/files
Same as listFiles, restricted to this app. For a branch's newest build: ?branch=main&limit=1.
Path parameters
appIdstring · uuidrequiredApp UUID
Query parameters
sha256stringOnly the file with this lowercase hex SHA-256.
platformstringOnly files for this platform.
bundleIdstringOnly files with this bundle id.
branchstringOnly files whose build.branch equals this.
commitstringOnly files whose build.commit equals this.
statusstringOnly files in this status. Without it, ready and processing files are listed; pendingUpload and failed are for debugging.
qstringCase-insensitive substring of the name, filename or bundle id.
limitintegerPage size, 1 to 100. Default 25.
cursorstring`nextCursor` from the previous page. Opaque.
Header parameters
X-Organization-IdstringSelects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
objectstringrequireddataarrayrequiredShow child attributes
idstring · uuidrequiredstatusstringrequiredpendingUpload: bytes not verified yet. processing: verification running (seen only by a concurrent caller). ready: installable. failed: see failureReason; creating the same sha256 again resets it.
appstring · uuidrequirednullableThe app this file belongs to, once metadata is extracted.
platformstringrequirednullableKnown once metadata is extracted.
filenamestringrequiredfilesizeinteger · int64requiredsha256stringrequirednamestringrequiredDisplay name. Defaults to the filename until metadata is extracted.
bundleIdstringrequirednullableAndroid package name or iOS bundle identifier.
versionstringrequirednullableVersion name (Android) or CFBundleShortVersionString (iOS).
buildNumberstringrequirednullableVersion code (Android) or CFBundleVersion (iOS).
minOsVersionstringrequirednullableMinimum OS version the build supports.
isSimulatorbooleanrequiredTrue for an iOS simulator build.
buildobjectrequirednullableShow child attributes
branchstringcommitstringciRunUrlstring · urihttps only. Stored and displayed, never fetched.
sourcestringrequiredHow the file was created, derived from the credential.
organizationstringrequiredOrganization that owns the file.
userstringrequirednullableUploader; null if the user was deleted.
failureReasonstringrequirednullableWhy the file failed; null otherwise.
createdAtstring · date-timerequiredlastUsedAtstring · date-timerequirednullableLast dedup hit or install.
expiresAtstring · date-timerequiredThe file and its bytes are deleted after this.
nextCursorstringPass as `cursor` for the next page. Absent on the last page.
Get an app's icon
GET/api/v1/apps/{appId}/icon
The icon as PNG (at most 512×512). Supports If-None-Match with the returned ETag. Any role.
Path parameters
appIdstring · uuidrequiredApp UUID
Header parameters
If-None-MatchstringX-Organization-IdstringSelects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Was this page helpful?