Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Your secret key, rk_test_… or rk_live_…, sent as Authorization: Bearer <key>. Keep it on your server. Restricted keys carry only the scopes you give them.

Headers

Reflections-Version
string

The dated API version. Defaults to the version your account is pinned to.

Example:

"2026-10-15"

Path Parameters

connection_id
string
required

The connection's ID.

Pattern: ^con_[0-9a-hjkmnp-tv-z]{26}$

Response

The connection.

id
string
required

Unique identifier for the connection, con_….

Pattern: ^con_[0-9a-hjkmnp-tv-z]{26}$
object
string
required

Always connection.

Allowed value: "connection"
livemode
boolean
required

true for a live-mode connection, false for a test-mode one.

status
enum<string>
required

active while the platform may act for the licensee. revoked once the licensee, the platform or Reflections ended it.

Available options:
active,
revoked
licensee
string
required

The account whose licenses the platform may use. Send it in Reflections-Account.

Pattern: ^acct_[0-9a-hjkmnp-tv-z]{26}$
platform
string
required

The platform account that acts for the licensee.

Pattern: ^acct_[0-9a-hjkmnp-tv-z]{26}$
scopes
enum<string>[]
required

What the platform may do for the licensee, as approved through OAuth. A call that needs a scope not listed fails with 403 account_not_connected.

Available options:
talent:read,
licenses:read,
license_requests:write,
files:write,
checks:write,
generations:write,
sessions:write,
revocations:write,
usage:write,
statements:read
licenses
object
required

Which of the licensee's licenses the platform may use.

created_at
string<date-time>
required

When the licensee approved the connection.

licensee_name
string

The licensee's account name.

platform_name
string

The platform's display_name, as the licensee saw it when approving.

revoked_by
enum<string> | null

Who ended the connection. null while it is active.

Available options:
licensee,
platform,
reflections,
null
revoked_at
string<date-time> | null

When the connection ended. From then, calls for the licensee fail with account_not_connected. null while it is active.