Skip to main content
GET
/
v1
/
orgs
/
{org_id}
/
sessions
List Sessions
curl --request GET \
  --url https://api.letpiper.com/v1/orgs/{org_id}/sessions/ \
  --header 'Authorization: Bearer <token>'
{
  "sessions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_name": "<string>",
      "channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "channel_type": "<string>",
      "channel_name": "<string>",
      "message_count": 123,
      "is_test": true,
      "scenario_run_status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Authorizations

​
Authorization
string
header
required

Platform token (starts with pat_)

Path Parameters

​
org_id
string<uuid>
required

Query Parameters

​
limit
integer
default:100
Required range: 1 <= x <= 500
​
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

Paginated list of sessions.

​
sessions
SessionListItem · object[]
required
​
total
integer
required