API ReferenceCLI Authentication

Get CLI session details by ID or code

Retrieves the current state of a CLI session using either the session ID (UUID) or the 6-character code. This endpoint is used by both the CLI client to check if the session has been linked, and by the web interface to display session details before linking.

Headers

x-api-keystringRequired

Query parameters

idstringRequired

CLI session ID (UUID format) or 6-character code to check. Both formats are supported for flexibility in client implementations.

Response

CLI session retrieved successfully. Returns full session details including linked account information if available.
idstring
The unique identifier for the CLI session
codestring

The 6-character hexadecimal code used for CLI login

statusenum
The current status of the session
Allowed values:
expiresAtstring
The ISO timestamp when the session expires
accountobject or null
Information about the linked account, if any. Null if the session status is "pending".

Errors