Skip to main content
GET
/
sessions
List sessions
curl --request GET \
  --url https://app.harmonica.chat/api/v1/sessions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "topic": "<string>",
      "goal": "<string>",
      "status": "active",
      "participant_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Pass your key as a Bearer token. Keys use the format hm_live_<32 hex chars>. Generate keys from your Harmonica dashboard settings.

Query Parameters

​
status
enum<string>

Filter by session status

Available options:
active,
completed
​
q
string

Search sessions by topic or goal

​
limit
integer
default:20

Number of results per page

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

Number of results to skip

Required range: x >= 0

Response

List of sessions

​
data
object[]
required
​
pagination
object
required