Skip to content
calternal docs

Get the mode order

GET
/api/v1/preferences/mode-order
curl --request GET \
  --url https://example.com/api/v1/preferences/mode-order \
  --header 'Authorization: Bearer <token>'

Returns the mode order. It requires a signed-in User with the account scope. It can return 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/preferences/mode-order. Inputs: . Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The current User’s saved mode order

Media typeapplication/json

The current User ID lets the Installation keep its local first-paint cache attached to the right User when several people sign in on one browser.

object
mode_order

None means no Installation has saved a custom order yet.

Array<string> | null
user_id
required

Immutable ID of the authenticated User.

string
Examplegenerated
{
  "mode_order": [
    "example"
  ],
  "user_id": "example"
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

403

Section titled “403”

Account scope required

Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}