Enrollments

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Query parameters

listing_idstringOptional

Only include enrollments for the specified listing

Responses

200

Listing enrollments

application/json

Responseobject

get

/api/v1/enrollments

HTTPcURLJavaScriptPython

GET /api/v1/enrollments HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Listing enrollments

{
  "enrollments": [
    {
      "id": 2,
      "user": {
        "id": 1
      },
      "listing": {
        "id": 44,
        "title": "Course 42",
        "type": "Course",
        "canvas_course_id": 26
      },
      "enrolled_at": "2024/01/01 00:00:00 +0000",
      "status": "active",
      "requirement_details": {
        "requirement_count": null,
        "requirement_completed_count": null,
        "requirement_completed_percentage": null
      }
    }
  ]
}

post

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/json

create_orderstringOptional

Create an order record for this enrollment, defaults to true

send_emailstringOptional

Send an enrollment email to the user, defaults to true

Responses

201

Creating an enrollment

application/json

post

/api/v1/enrollments

HTTPcURLJavaScriptPython

POST /api/v1/enrollments HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "create_order": "text",
  "send_email": "text",
  "enrollment": {
    "listing_id": "text",
    "canvas_user_id": "text"
  }
}

201

Creating an enrollment

{
  "enrollment": {
    "id": 5,
    "user": {
      "id": 1
    },
    "listing": {
      "id": 47,
      "title": "Course 45",
      "type": "Course",
      "canvas_course_id": 29
    },
    "enrolled_at": "2024/01/01 00:00:00 +0000",
    "status": "active",
    "requirement_details": {
      "requirement_count": 10,
      "requirement_completed_count": 4,
      "requirement_completed_percentage": 40
    }
  }
}

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Responses

200

Getting a specific enrollment

application/json

get

/api/v1/enrollments/{id}

HTTPcURLJavaScriptPython

GET /api/v1/enrollments/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Getting a specific enrollment

{
  "enrollment": {
    "id": 4,
    "user": {
      "id": 1
    },
    "listing": {
      "id": 46,
      "title": "Course 44",
      "type": "Course",
      "canvas_course_id": 28
    },
    "enrolled_at": "2024/01/01 00:00:00 +0000",
    "status": "active",
    "requirement_details": {
      "requirement_count": 10,
      "requirement_completed_count": 4,
      "requirement_completed_percentage": 40
    }
  }
}

delete

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Responses

204

Deleting an enrollment

*/*

delete

/api/v1/enrollments/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/enrollments/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

204

Deleting an enrollment

{
  "id": "text",
  "user": {
    "id": "text"
  },
  "listing": {
    "id": "text",
    "title": "text",
    "type": "text",
    "canvas_course_id": "text"
  },
  "enrolled_at": "text",
  "status": "text",
  "requirement_details": {
    "requirement_count": "text",
    "requirement_completed_count": "text",
    "requirement_completed_percentage": "text"
  }
}