Skip to main content
GET
Get tap

Authorizations

x-api-key
string
header
required

Send your API key in the x-api-key header of every request. The key belongs to one Orbital account, and requests act as that account: they see and control only the devices it owns or has been given access to. A missing or unknown key gets 403 with { "message": "Forbidden" }.

Path Parameters

id
string
required

The unique identifier for the tap

Response

Success

id
string<uuid>

Unique ID of the device (UUID).

Example:

"e3d2c1b0-a9f8-4e7d-9c6b-5a4f3e2d1c0b"

name
string

Display name of the device.

Example:

"Kitchen sink"

owner
string | null

User ID of the owner. null when the device isn’t paired.

Example:

"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"

device_group
string | null

ID of the group the device belongs to. Pairing sets it to your user ID.

Example:

"6f1c2e0a-3d4b-4e8f-9a7c-2b5d1e3f4a6b"

state
enum<string>

Lifecycle state. A device is pending until it is first paired, then active. Lists only include pending and active devices.

Available options:
pending,
active,
archived,
service,
replaced
Example:

"active"

last_connected
string

When the device last connected (ISO 8601).

Example:

"2026-11-02T06:40:12.000Z"

last_disconnected
string

When the device last disconnected (ISO 8601). The device is offline when this is later than last_connected.

Example:

"2026-11-01T23:10:05.000Z"

build_id
string

Firmware build running on the tap.

Example:

"tap-1.2.1"

wifi_ssid
string

Name of the Wi-Fi network the tap is on.

Example:

"HomeNetwork"

type
enum<string>

Always tap.

Available options:
tap
Example:

"tap"

created_at
string

When the record was created (ISO 8601).

Example:

"2026-03-14T09:12:44.000Z"

updated_at
string

When the record was last changed (ISO 8601).

Example:

"2026-10-28T17:03:10.000Z"

role
enum<string>

Your access to the device: owner (you paired it) or, for a device shared with you, user or maintenance. maintenance can read the device but not change it, control it or see its sessions. Only included by GET /client/taps and GET /client/taps/{id}.

Available options:
owner,
maintenance,
user
Example:

"owner"