A valid request URL is required to generate request examples{
"queue": {
"deviceId": "<string>",
"scopeId": "user_0",
"entries": [
{
"entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestKey": "<string>",
"appId": "<string>",
"buildId": "<string>",
"name": "<string>",
"packageName": "<string>",
"versionName": "<string>",
"deviceId": "<string>",
"scopeId": "user_0",
"state": "waiting",
"position": 5,
"createdAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"endedReason": "removed_by_person",
"installation": {
"installationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestKey": "<string>",
"appId": "<string>",
"buildId": "<string>",
"name": "<string>",
"packageName": "<string>",
"versionName": "<string>",
"deviceId": "<string>",
"scopeId": "user_0",
"status": "queued",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"receiptId": "<string>",
"reasonCode": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
}
],
"active": {
"installationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestKey": "<string>",
"appId": "<string>",
"buildId": "<string>",
"name": "<string>",
"packageName": "<string>",
"versionName": "<string>",
"deviceId": "<string>",
"scopeId": "user_0",
"status": "queued",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"receiptId": "<string>",
"reasonCode": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"canInstallNow": true,
"canJoin": true,
"joinBlocker": "store_unavailable",
"pausedReason": "installation_paused",
"paused": true,
"limit": 10,
"count": 1
}
}{
"error": {
"code": "preview_changed",
"message": "A selected device has changed. Review the devices again.",
"requestId": "req_01",
"field": null,
"retry": "new_preview",
"retryAfterSeconds": null
}
}{
"error": {
"code": "preview_changed",
"message": "A selected device has changed. Review the devices again.",
"requestId": "req_01",
"field": null,
"retry": "new_preview",
"retryAfterSeconds": null
}
}{
"error": {
"code": "preview_changed",
"message": "A selected device has changed. Review the devices again.",
"requestId": "req_01",
"field": null,
"retry": "new_preview",
"retryAfterSeconds": null
}
}{
"error": {
"code": "preview_changed",
"message": "A selected device has changed. Review the devices again.",
"requestId": "req_01",
"field": null,
"retry": "new_preview",
"retryAfterSeconds": null
}
}{
"error": {
"code": "rate_limited",
"message": "<string>"
}
}{
"error": {
"code": "preview_changed",
"message": "A selected device has changed. Review the devices again.",
"requestId": "req_01",
"field": null,
"retry": "new_preview",
"retryAfterSeconds": null
}
}Read a phone's install queue
The per-phone install queue. A phone installs one app at a time; more apps wait in line in the order they were added, at most 10 per phone (the installing one included) and 50 waiting or unfinished per workspace. A waiting app sends nothing to the phone and holds no lease. When the installing app is finished and the phone is free, the oldest waiting app starts by itself as an ordinary installation with the same id and request key, re-checked against current permission, phone, profile and catalogue build before anything is sent; its own time limits start then. An installation whose result is not confirmed pauses the line until it is checked: the next app never replaces or repeats it. Requires apps:read, devices:read. Says whether an app added now would start at once, whether another may join, and why not.
A valid request URL is required to generate request examples{
"queue": {
"deviceId": "<string>",
"scopeId": "user_0",
"entries": [
{
"entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestKey": "<string>",
"appId": "<string>",
"buildId": "<string>",
"name": "<string>",
"packageName": "<string>",
"versionName": "<string>",
"deviceId": "<string>",
"scopeId": "user_0",
"state": "waiting",
"position": 5,
"createdAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"endedReason": "removed_by_person",
"installation": {
"installationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestKey": "<string>",
"appId": "<string>",
"buildId": "<string>",
"name": "<string>",
"packageName": "<string>",
"versionName": "<string>",
"deviceId": "<string>",
"scopeId": "user_0",
"status": "queued",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"receiptId": "<string>",
"reasonCode": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
}
}
],
"active": {
"installationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requestKey": "<string>",
"appId": "<string>",
"buildId": "<string>",
"name": "<string>",
"packageName": "<string>",
"versionName": "<string>",
"deviceId": "<string>",
"scopeId": "user_0",
"status": "queued",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"receiptId": "<string>",
"reasonCode": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z"
},
"canInstallNow": true,
"canJoin": true,
"joinBlocker": "store_unavailable",
"pausedReason": "installation_paused",
"paused": true,
"limit": 10,
"count": 1
}
}{
"error": {
"code": "preview_changed",
"message": "A selected device has changed. Review the devices again.",
"requestId": "req_01",
"field": null,
"retry": "new_preview",
"retryAfterSeconds": null
}
}{
"error": {
"code": "preview_changed",
"message": "A selected device has changed. Review the devices again.",
"requestId": "req_01",
"field": null,
"retry": "new_preview",
"retryAfterSeconds": null
}
}{
"error": {
"code": "preview_changed",
"message": "A selected device has changed. Review the devices again.",
"requestId": "req_01",
"field": null,
"retry": "new_preview",
"retryAfterSeconds": null
}
}{
"error": {
"code": "preview_changed",
"message": "A selected device has changed. Review the devices again.",
"requestId": "req_01",
"field": null,
"retry": "new_preview",
"retryAfterSeconds": null
}
}{
"error": {
"code": "rate_limited",
"message": "<string>"
}
}{
"error": {
"code": "preview_changed",
"message": "A selected device has changed. Review the devices again.",
"requestId": "req_01",
"field": null,
"retry": "new_preview",
"retryAfterSeconds": null
}
}Authorizations
The control surface credential. Send Authorization: Bearer <token>.
Two kinds of token are accepted and they are told apart by shape, not by a separate header. A token beginning pbk_ or puk_ is an org scoped API key, whose public half and secret half are generated together and of which only a hash of the secret is ever stored; anything else is treated as an OAuth 2.1 access token and verified against the authorization server's keys.
Both resolve to the same context: an org, a principal and a set of scopes. Nothing downstream branches on which channel you used, with one deliberate exception, key management, which requires a signed-in person so that a key can never mint another key.
Scopes are enforced when MCP tools are REGISTERED rather than when they are called, so a tool your credential cannot use is absent from tools/list rather than refused mid gesture.