Sessions

List sessions

get

https://api.haloproject.com/v1https://sandbox.api.haloproject.com/v1

/sessions

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

userIdstringOptional

Responses

200

List

application/json

get

/sessions

HTTPcURLJavaScriptPython

GET /v1/sessions HTTP/1.1
Host: api.haloproject.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

List

[
  {
    "id": "text",
    "userId": "text",
    "deviceId": "text",
    "started_at": "2025-12-18T17:29:11.513Z",
    "status": "created"
  }
]

Create a recording session

post

https://api.haloproject.com/v1https://sandbox.api.haloproject.com/v1

/sessions

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

userIdstringRequired

deviceIdstringRequired

protocolstringOptionalExample: pilot-v1

notesstringOptional

Responses

201

Created

application/json

post

/sessions

HTTPcURLJavaScriptPython

POST /v1/sessions HTTP/1.1
Host: api.haloproject.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "userId": "text",
  "deviceId": "text",
  "protocol": "pilot-v1",
  "notes": "text"
}

201

Created

{
  "id": "text",
  "userId": "text",
  "deviceId": "text",
  "started_at": "2025-12-18T17:29:11.513Z",
  "status": "created"
}