API reference / Devices
List assigned devices
Returns accessible phones assigned to this key and account, including assigned rentals.
/api/v1/devicesAuthorization
devices:readSend Authorization: Bearer <FLEETDECK_API_KEY> with the scope above. The key must also grant access to the target device. Authentication guide ↗
Request example
curl --request GET \
--url 'https://fleetdeck.co/api/v1/devices' \
--header "Authorization: Bearer $FLEETDECK_API_KEY"Replace example IDs with returned values. Read credentials from your private environment.
Response examples
{
"devices": [
{
"id": "device_123",
"name": "Test phone",
"platform": "android",
"model": null,
"os": null,
"status": "online",
"lastSeenAt": "2030-01-01T10:00:00.000Z",
"relayRegion": "eu",
"agentWebrtc": false,
"wdaStatus": "idle"
}
]
}Request body
This endpoint does not require a request body.
Behavior and limits
Returns accessible phones assigned to this key and account, including assigned rentals. An empty devices array is valid. Inventory status is not a readiness check; inspect capabilities and verify capture before acting.
Response 200
DeviceList · application/json
devicesobject[]always presentDevices granted to the current key. An empty array is a valid result.
View child fields
idstringalways presentUnique identifier of this resource. Use the returned value in subsequent requests.
"device_123"Validation pattern
^[A-Za-z0-9._:-]+$namestringalways presentName of the resource or operation. For commands with an enum, choose one of the listed values.
"Test phone"platformstringalways presentPhone platform reported by the device, such as ios or android.
"android"modelstring | nullalways presentDevice model reported by the phone, or null when unavailable.
osstring | nullalways presentOperating system version reported by the phone, or null when unavailable.
statusstringalways presentCurrent state. A completed action means the driver finished; verify the intended screen or app effect separately.
"online"lastSeenAtstring | nullalways presentMost recent recorded device contact, or null when no contact is recorded.
"2030-01-01T10:00:00.000Z"relayRegionstringalways presentRelay region used for the phone connection.
"eu"agentWebrtcbooleanalways presentWhether the phone advertises agent WebRTC support. This does not guarantee a usable JPEG screenshot stream.
falsewdaStatusstringalways presentReported WebDriverAgent availability. Check current capabilities before choosing a command.
"idle"Errors
Expand a code for its recovery steps. Responses use error and code; validation errors also include issues.
401UNAUTHORIZEDMissing, malformed, expired or revoked credential; user verification/password state can also deny access.
Recovery: Use Authorization: Bearer with a valid scoped key. For dashboard routes, sign in. Job children require an active parent job and timely renewal.
Full error reference ↗403FORBIDDENRequired scope, device grant, account membership or worker identity is missing.
Recovery: Check the endpoint’s scopes, exact device, owning key and workerId. A different key cannot access the original key’s sessions or jobs.
Full error reference ↗500INTERNALUnexpected service error.
Recovery: Save nonsecret request context and time for support. Query action status before repeating a mutation; never assume it did not execute.
Full error reference ↗Example error messages are illustrative. Match the code and HTTP status; do not depend on exact message wording.
