FleetDeckDocs

API reference / Account

Check this key

Connection test for Zapier, Make, n8n and scripts.

GET/api/v1/me

Authorization

Bearer tokenAny valid key (no scope required)

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/me' \
  --header "Authorization: Bearer $FLEETDECK_API_KEY"

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

Response examples
200 · success
{
  "account": {
    "id": "account_123",
    "name": "Acme Studio"
  },
  "user": {
    "id": "user_123",
    "email": "owner@example.com",
    "role": "owner"
  },
  "key": {
    "id": "key_123",
    "name": "My agent",
    "prefix": "fd_example",
    "scopes": [
      "devices:read"
    ],
    "expiresAt": null,
    "createdAt": "2030-01-01T10:00:00.000Z"
  },
  "deviceIds": [
    "device_123"
  ]
}

Request body

This endpoint does not require a request body.

Behavior and limits

Connection test for Zapier, Make, n8n and scripts. Returns the account name, key owner, key scopes, expiry and the device IDs assigned to the key. Assigned IDs are not a promise of current access; per-device grants and entitlement are checked on each device call. The token itself is never returned.

Response 200

Me · application/json

accountobject | nullalways present
View child fields
idstringalways present

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

min 1 charactersmax 128 characters
Example: "account_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: "Acme Studio"
userobjectalways present
View child fields
idstringalways present

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

min 1 charactersmax 128 characters
Example: "user_123"
Validation pattern^[A-Za-z0-9._:-]+$
emailstringalways present
Example: "owner@example.com"
rolestringalways present
Example: "owner"
keyobjectalways present

Keyboard key to send to the currently focused control.

View child fields
idstringalways present

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

min 1 charactersmax 128 characters
Example: "key_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: "My agent"
prefixstringalways present

Nonsecret token prefix for identifying a key in the dashboard.

Example: "fd_example"
scopesstring[]always present

Permissions granted to the key. Operations can require more than one scope.

expiresAtstring | nullalways present

UTC instant when this lease or credential expires. Read each renewal response for the current deadline.

date-time
createdAtstringalways present

UTC instant when the record was created.

date-time
Example: "2030-01-01T10:00:00.000Z"
deviceIdsstring[]always present

Exact IDs of the devices this key may access.

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 ↗
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.