Skip to main content
GET
Get user

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" }.

Response

User details retrieved successfully

id
string

Unique ID of the user.

Example:

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

group_id
string

ID of the group your account belongs to.

Example:

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

address
object

Postal address.

company
string

Company name.

Example:

"Orbital Systems"

email
string

Email address the user signs in with.

Example:

"alex@example.com"

firstname
string

First name.

Example:

"Alex"

lastname
string

Last name.

Example:

"Andersson"

notification_app
boolean

Sends notifications to the Orbital app.

Example:

true

notification_email
boolean

Sends notifications by email.

Example:

false

notification_interval
enum<string> | null

Collects non-urgent notifications into a daily or weekly summary. null sends each one as it happens.

Available options:
daily,
weekly
Example:

null

phone_number
string

Phone number.

Example:

"+46701234567"

volume_unit
enum<string>

Volume unit shown in the app: litre or gallon.

Available options:
litre,
gallon
Example:

"litre"

temperature_unit
enum<string>

Temperature unit shown in the app: celsius or fahrenheit.

Available options:
celsius,
fahrenheit
Example:

"celsius"

Stored for the Orbital app; the API doesn’t act on it.

Example:

true

google_home
boolean

Whether Google Home is linked to the account.

Example:

false

alexa
boolean

Whether Alexa has been linked to the account.

Example:

false

dark_theme
boolean

Stored for the Orbital app; the API doesn’t act on it.

Example:

false

use_phone_theme
boolean

Stored for the Orbital app; the API doesn’t act on it.

Example:

true

updated_at
string

When the record was last changed (ISO 8601).

Example:

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

automatic_timezone
boolean

Stored for the Orbital app; the API doesn’t act on it.

Example:

true

locale
string

Language code for emails and push notifications. Defaults to en.

Example:

"en"

sharing_requests
boolean

Lets someone ask for access when they try to pair a device you own. When off, they get 403 with code 1.

Example:

true