Skip to main content
GET
Retrieve a Connect session

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Path Parameters

session_id
string
required

Flatpeak Connect Session ID.

Response

Connect session response.

A Connect session. Returned on creation and on retrieval; device_id is populated once the customer completes Connect.

id
string
required

Flatpeak Connect Session ID.

Example:

"cos_6a3196d6e61a44f33f7307ed"

object
enum<string>
required

Object type, connect_session.

Available options:
connect_session
Example:

"connect_session"

live_mode
boolean
required

true for live data, false for test data.

Example:

false

oem_id
string
required

Flatpeak OEM ID: the OEM the customer signs in with. Fixed for the session.

Pattern: ^oem_[A-Za-z0-9]+$
Example:

"oem_6a3a8dada72cd0a249ff9528"

program_id
string
required

Program the customer enrolls the device in.

Example:

"vpr_5c8d1f2a7b3e4d6c9a0f1b2c"

device_id
string | null
required

The connected device; null until the customer completes Connect or if they exit.

Example:

"dev_63a6087272941ef077a8fd3e"

target_url
string
required

URL to redirect the customer to, with the session ID appended as connect_session, for example https://universal.flatpeak.com/?connect_session=cos_6a3196d6e61a44f33f7307ed.

Example:

"https://universal.flatpeak.com"

callback_url
string
required

URL the customer returns to after they complete or exit Connect.

Example:

"myapp://superenergy/flatpeak/complete"

time_created
string<date-time>
required

Time when the object was created, in UTC.

Example:

"2026-05-05T18:37:27Z"

time_expiry
string<date-time>
required

Time when the session expires, in UTC: 48 hours after creation.

Example:

"2026-05-07T18:37:27Z"

account_id
string
required

Flatpeak Account ID of the operator that owns the Connect session.

Pattern: ^[a-z]{2,4}_[A-Za-z0-9]+$
Example:

"acc_6a5e504c3b98d0d6739b5f72"