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

Get catalog overview.

Get catalog overview. An organization-scoped read using JSON filter arguments; requires catalog.read. Pagination cursors must be reused only with the same organization, operation and filters.

POST/queries/get_catalog_overview
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
now_msstring<date-time>required
Responses
200

Successful read.

dataobjectrequired
Show properties
countsobjectrequired
Show properties
capacity_warningsnumberrequired
enrollments_activenumberrequired
offerings_activenumberrequired
offerings_draftnumberrequired
participants_activenumberrequired
pending_enrollmentsnumberrequired
programs_activenumberrequired
programs_draftnumberrequired
progress_tasksnumberrequired
roster_tasksnumberrequired
upcoming_sessionsnumberrequired
waitlisted_enrollmentsnumberrequired
owner_metricsobject | nullrequired
Show properties
Any of:
null
null
object
capacity_warningsobject[]required
Show properties
Array of object
capacitynumberrequired
confirmed_countnumberrequired
levelstringrequired
Show properties
Any of:
string
string
string
string
string
string
string
string
offering_idstringrequired

Opaque Soljio resource ID.

min length 1
offering_namestringrequired
waitlist_countnumberrequired
recent_activityobject[]required
Show properties
Array of object
actionstringrequired
actor_kindstringrequired
Show properties
Any of:
string
string
string
string
string
string
created_atstring<date-time>required
target_idstring
target_tablestring
setupobjectrequired
Show properties
has_active_offeringbooleanrequired
has_active_programbooleanrequired
has_upcoming_sessionbooleanrequired
upcoming_sessionsobject[]required
Show properties
Array of object
capacitynumber
ends_atstring<date-time>required
enrolled_countnumberrequired
idstringrequired

Opaque Soljio resource ID.

min length 1
offering_namestringrequired
roster_openbooleanrequired
starts_atstring<date-time>required
statusstringrequired
timezonestring
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_catalog_overview' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "now_ms": "2019-08-24T14:15:22Z"
}'
Response
{
  "data": {
    "counts": {
      "capacity_warnings": 0,
      "enrollments_active": 0,
      "offerings_active": 0,
      "offerings_draft": 0,
      "participants_active": 0,
      "pending_enrollments": 0,
      "programs_active": 0,
      "programs_draft": 0,
      "progress_tasks": 0,
      "roster_tasks": 0,
      "upcoming_sessions": 0,
      "waitlisted_enrollments": 0
    },
    "owner_metrics": {},
    "setup": {
      "has_active_offering": true,
      "has_active_program": true,
      "has_upcoming_session": true
    },
    "upcoming_sessions": [
      {
        "capacity": 0,
        "ends_at": "2019-08-24T14:15:22Z",
        "enrolled_count": 0,
        "id": "string",
        "offering_name": "string",
        "roster_open": true,
        "starts_at": "2019-08-24T14:15:22Z",
        "status": "string",
        "timezone": "string"
      }
    ]
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}

Was this page helpful?