FleetDeckDocs

API reference / Touch automations

List touch schedules

Returns up to 100 active (not deleted) touch schedules for the phone, newest first, plus whether the touch scheduler is online.

GET/api/v1/devices/{deviceId}/touch-schedules

Authorization

Bearer tokendevices:read

Send Authorization: Bearer <FLEETDECK_API_KEY> with the scope above. The key must also grant access to the target device. Authentication guide ↗

Request example
Request · cURL
curl --request GET \
  --url 'https://fleetdeck.co/api/v1/devices/device_123/touch-schedules' \
  --header "Authorization: Bearer $FLEETDECK_API_KEY"

Replace example IDs with returned values. Read credentials from your private environment.

Response examples
200 · success
{
  "deviceId": "device_123",
  "schedules": [
    {
      "id": "schedule_123",
      "name": "Morning check-in",
      "sequenceId": "seq_123",
      "cron": "0 9 * * 1-5",
      "timezone": "Europe/Bratislava",
      "runAt": null,
      "failureEmail": null,
      "enabled": true,
      "nextRunAt": "2030-01-01T10:00:00.000Z",
      "createdAt": "2030-01-01T10:00:00.000Z"
    }
  ],
  "worker": {
    "online": true,
    "lastSeenAt": "2030-01-01T10:00:00.000Z"
  }
}

Path parameters

deviceIdstringrequired

Exact device ID from List devices. The current key must grant access to this phone.

min 1 charactersmax 128 characters
Example: "device_123"
Validation pattern^[A-Za-z0-9._:-]+$

Request body

This endpoint does not require a request body.

Behavior and limits

Returns up to 100 active (not deleted) touch schedules for the phone, newest first, plus whether the touch scheduler is online. These are the same schedules shown in the dashboard; they belong to the user, not the key.

Response 200

TouchScheduleList · application/json

deviceIdstringalways present

Exact device ID from List devices. The current key must grant access to this phone.

min 1 charactersmax 128 characters
Example: "device_123"
Validation pattern^[A-Za-z0-9._:-]+$
schedulesobject[]always present
View child fields
idstringalways present

Unique identifier of this resource. Use the returned value in subsequent requests.

min 1 charactersmax 128 characters
Example: "schedule_123"
Validation pattern^[A-Za-z0-9._:-]+$
namestringalways present

Name of the resource or operation. For commands with an enum, choose one of the listed values.

Example: "Morning check-in"
sequenceIdstringalways present
Example: "seq_123"
cronstringalways present

Five-field cron, or empty for a one-time run

Example: "0 9 * * 1-5"
timezonestringalways present

IANA timezone metadata. scheduledAt remains the authoritative execution instant.

Example: "Europe/Bratislava"
runAtstring | nullalways present
date-time
failureEmailstring | nullalways present
enabledbooleanalways present
Example: true
nextRunAtstringalways present
date-time
Example: "2030-01-01T10:00:00.000Z"
createdAtstringalways present

UTC instant when the record was created.

date-time
Example: "2030-01-01T10:00:00.000Z"
workerobjectalways present
View child fields
onlinebooleanalways present
Example: true
lastSeenAtstring | nullalways present

Most recent recorded device contact, or null when no contact is recorded.

date-time
Example: "2030-01-01T10:00:00.000Z"

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 ↗
404NOT_FOUNDUnknown route or resource unavailable to this caller.

Recovery: Check method/path and use returned IDs from this account/key. Do not guess IDs.

Full error reference ↗
402PLAN_REQUIREDDevice account has no active entitlement.

Recovery: Restore an active device entitlement in the workspace before controlling it.

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.