Create Read Only Session

Create a read only session for a user (valid for 1 hour)

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_read_only_session \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION",
    "timestampMs": "<string> (e.g., 1745474677466)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {}
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g., 1745474677466)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createReadOnlySessionIntent": {}
        },
        "result": {
          "createReadOnlySessionResult": {
            "organizationId": "<string>",
            "organizationName": "<string>",
            "userId": "<string>",
            "username": "<string>",
            "session": "<string>",
            "sessionExpiry": "<string>"
          }
        }
      }
    }
  }
}