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

Get enrollment

Organization-scoped enrollment read. Requires enrollments.read. Unknown or repeated query parameters are rejected.

GET/enrollments/{id}
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.

Path parameters
idstringrequired

Resource ID within the token organization. Foreign and missing records are indistinguishable.

min length 1 · max length 256
Responses
200

Successful operation.

dataEnrollmentrequired
Show properties
idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
organization_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
statusstringrequired
updated_atstring<date-time>required
objectstringrequired
created_atstring<date-time>required
offering_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
participant_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
session_idstring

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
payment_statusstring
enrolled_atstring<date-time>
confirmed_atstring<date-time>
waitlisted_atstring<date-time>
canceled_atstring<date-time>
transferred_atstring<date-time>
completed_atstring<date-time>
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
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
Parameters
Request
curl -X GET 'https://api.soljio.com/v0/enrollments/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "id": "string",
    "organization_id": "string",
    "status": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "object": "enrollment",
    "created_at": "2019-08-24T14:15:22Z",
    "offering_id": "string",
    "participant_id": "string",
    "session_id": "string",
    "payment_status": "string",
    "enrolled_at": "2019-08-24T14:15:22Z",
    "confirmed_at": "2019-08-24T14:15:22Z",
    "waitlisted_at": "2019-08-24T14:15:22Z",
    "canceled_at": "2019-08-24T14:15:22Z",
    "transferred_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z"
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}

Was this page helpful?