Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

Get a complete class date roster with registration answers in one snapshot, for export.

Get a complete class date roster with registration answers in one snapshot, for export. An organization-scoped read using JSON filter arguments; requires roster.read. Pagination cursors must be reused only with the same organization, operation and filters.

POST/queries/get_session_roster_export
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.

Request body
requiredapplication/json
session_idstringrequired

Opaque Soljio resource ID.

min length 1
Responses
200

Successful read.

dataobjectrequired
Show properties
answersobject[]required
Show properties
Array of object
answersobject[]required
Show properties
Array of object
promptstringrequired
question_idstringrequired

Opaque Soljio resource ID.

min length 1
valuestringrequired
enrollment_idstringrequired

Opaque Soljio resource ID.

min length 1
rosterobject | nullrequired
Show properties
Any of:
null
null
object
can_manage_enrollment_operationsbooleanrequired
capacitynumber
countsobjectrequired
Show properties
absentnumberrequired
cancelednumberrequired
confirmednumberrequired
waitlistednumberrequired
location_namestring
offeringobjectrequired
Show properties
idstringrequired

Opaque Soljio resource ID.

min length 1
namestringrequired
statusstringrequired
Show properties
Any of:
string
string
string
string
string
string
program_namestringrequired
rowsobject[]required
Show properties
Array of object
attendance_statusstringrequired
Show properties
Any of:
string
Any of:
string
string
string
string
string
string
string
string
string
string
available_makeup_credit_idstring

Opaque Soljio resource ID.

min length 1
available_makeup_creditsnumberrequired
contact_hintsobject[]required
Show properties
Array of object
display_namestring
emailstring
phonestring
relationshipstring
rolestringrequired
covers_all_class_datesbooleanrequired
enrollment_idstring

Opaque Soljio resource ID.

min length 1
enrollment_statusstringrequired
Show properties
Any of:
string
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
string
string
makeup_credit_issued_for_attendancebooleanrequired
makeup_visit_credit_idstring

Opaque Soljio resource ID.

min length 1
participantobjectrequired
Show properties
date_of_birthstring
display_namestringrequired
idstringrequired

Opaque Soljio resource ID.

min length 1
safetyobject | nullrequired
Show properties
Any of:
null
null
object
allergiesstring
emergency_contactsobject[]required
Show properties
Array of object
namestringrequired
phonestringrequired
relationshipstring
medical_notesstring
swim_abilitystring
statusstringrequired
payment_statusstring
Show properties
Any of:
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
waitlist_positionnumber
sessionobjectrequired
Show properties
cancel_reasonstring
ends_atstring<date-time>required
idstringrequired

Opaque Soljio resource ID.

min length 1
starts_atstring<date-time>required
statusstringrequired
timezonestring
truncatedbooleanrequired
request_idstring<uuid>required
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
409

conflict, idempotency_conflict

errorobjectrequired
Show properties
codestringrequired
Allowed:conflictidempotency_conflict
messagestringrequired
request_idstring<uuid>required
413

payload_too_large

errorobjectrequired
Show properties
codestringrequired
Allowed:payload_too_large
messagestringrequired
request_idstring<uuid>required
415

unsupported_media_type

errorobjectrequired
Show properties
codestringrequired
Allowed:unsupported_media_type
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.soljio.com/v0/queries/get_session_roster_export' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "session_id": "string"
}'
Response
{
  "data": {
    "answers": [
      {
        "answers": [
          {
            "prompt": "string",
            "question_id": "string",
            "value": "string"
          }
        ],
        "enrollment_id": "string"
      }
    ],
    "roster": {},
    "truncated": true
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}