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_overviewAuthorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequiredOrganization-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/jsonnow_msstring<date-time>requiredResponses
200
Successful read.
dataobjectrequiredShow propertiesHide properties
countsobjectrequiredShow propertiesHide properties
capacity_warningsnumberrequiredenrollments_activenumberrequiredofferings_activenumberrequiredofferings_draftnumberrequiredparticipants_activenumberrequiredpending_enrollmentsnumberrequiredprograms_activenumberrequiredprograms_draftnumberrequiredprogress_tasksnumberrequiredroster_tasksnumberrequiredupcoming_sessionsnumberrequiredwaitlisted_enrollmentsnumberrequiredowner_metricsobject | nullrequiredShow propertiesHide properties
Any of:
null
nullobject
capacity_warningsobject[]requiredShow propertiesHide properties
Array of
objectcapacitynumberrequiredconfirmed_countnumberrequiredlevelstringrequiredShow propertiesHide properties
Any of:
string
stringstring
stringstring
stringstring
stringoffering_idstringrequiredOpaque Soljio resource ID.
min length 1
offering_namestringrequiredwaitlist_countnumberrequiredrecent_activityobject[]requiredShow propertiesHide properties
Array of
objectactionstringrequiredactor_kindstringrequiredShow propertiesHide properties
Any of:
string
stringstring
stringstring
stringcreated_atstring<date-time>requiredtarget_idstringtarget_tablestringsetupobjectrequiredShow propertiesHide properties
has_active_offeringbooleanrequiredhas_active_programbooleanrequiredhas_upcoming_sessionbooleanrequiredupcoming_sessionsobject[]requiredShow propertiesHide properties
Array of
objectcapacitynumberends_atstring<date-time>requiredenrolled_countnumberrequiredidstringrequiredOpaque Soljio resource ID.
min length 1
offering_namestringrequiredroster_openbooleanrequiredstarts_atstring<date-time>requiredstatusstringrequiredtimezonestringrequest_idstring<uuid>required400
invalid_request
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
invalid_requestmessagestringrequiredrequest_idstring<uuid>required401
unauthorized
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
unauthorizedmessagestringrequiredrequest_idstring<uuid>required403
forbidden
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
forbiddenmessagestringrequiredrequest_idstring<uuid>required404
not_found
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
not_foundmessagestringrequiredrequest_idstring<uuid>required405
method_not_allowed
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
method_not_allowedmessagestringrequiredrequest_idstring<uuid>required409
conflict, idempotency_conflict
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
conflictidempotency_conflictmessagestringrequiredrequest_idstring<uuid>required413
payload_too_large
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
payload_too_largemessagestringrequiredrequest_idstring<uuid>required415
unsupported_media_type
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
unsupported_media_typemessagestringrequiredrequest_idstring<uuid>required429
rate_limited
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
rate_limitedmessagestringrequiredrequest_idstring<uuid>required500
internal_error
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
internal_errormessagestringrequiredrequest_idstring<uuid>required