Skip to main content
GET
/
v1
/
sessions
List Sessions
curl --request GET \
  --url https://api.example.com/v1/sessions

Documentation Index

Fetch the complete documentation index at: https://docs.tapkit.ai/llms.txt

Use this file to discover all available pages before exploring further.

List all sessions for your organization. Supports filtering by status and phone.

​
Request

curl https://api.tapkit.ai/v1/sessions \
  -H "X-API-Key: joot_your_api_key"

​
Query Parameters

ParameterTypeDefaultDescription
statusstring—Filter by status: creating, running, paused, completed, failed, killed
phone_idstring—Filter by phone ID
limitinteger20Number of sessions to return (1–100)

​
Response

Status: 200 OK 
{
  "sessions": [
    {
      "id": "sess_abc123",
      "phone_id": "abc123-def456",
      "instruction": "Open Instagram and like the first 3 posts",
      "status": "completed",
      "cost_usd": 0.42,
      "duration_ms": 45200,
      "num_turns": 12,
      "error": null,
      "created_at": "2024-01-15T10:30:00Z",
      "started_at": "2024-01-15T10:30:02Z",
      "completed_at": "2024-01-15T10:30:47Z"
    }
  ]
}

​
Response Fields

FieldTypeDescription
sessionsarrayArray of session objects (see Create Session for field details)

​
Examples

​
List Running Sessions

curl "https://api.tapkit.ai/v1/sessions?status=running" \
  -H "X-API-Key: joot_..."

​
Python

import requests

response = requests.get(
    "https://api.tapkit.ai/v1/sessions",
    headers={"X-API-Key": "joot_..."},
    params={"status": "running", "limit": 50}
)

sessions = response.json()["sessions"]
for s in sessions:
    print(f"{s['id']}: {s['status']} - {s['instruction'][:50]}")