Skip to main content
GET
/
api
/
roleplay
/
session
Session - Get All Sessions
curl --request GET \
  --url https://app.replay.sale/api/roleplay/session \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "score": 50,
      "createdAt": "2023-11-07T05:31:56Z",
      "userName": "<string>",
      "didPass": true,
      "roleplayId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "length": 1,
      "roleplayTitle": "<string>"
    }
  ],
  "pagination": {
    "total": 1,
    "offset": 1,
    "limit": 500,
    "hasMore": true
  }
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get your API key from your company settings.

Query Parameters

​
offset
integer
default:0

Number of records to skip (default: 0)

Required range: x >= 0
​
limit
integer
default:100

Maximum records to return (default: 100, max: 1000)

Required range: 1 <= x <= 1000
​
userId
string<uuid>

Filter by specific user ID (optional)

​
roleplayId
string<uuid>

Filter by specific roleplay ID (optional)

Response

Successfully retrieved sessions

​
data
object[]
required
​
pagination
object
required