Courses

get
All Courses

https://yoursite.mavenseed.com/api/v1/courses
Retrieve all courses
Request
Response
Request
Path Parameters
page
optional
integer
Results are paginated.
Headers
Authorization
required
string
Auth token
Response
200: OK
Returns an array of courses. Only the first 20 are returned. Passing the page param will paginate the results.
[
{
"id": 5,
"title": "Creating a Realistic 3D Photo Scanned Pumpkin",
"slug": "creating-a-realistic-3d-photo-scanned-pumpkin",
"status": "published",
"created_at": "2019-02-20T14:15:01.393-05:00",
"updated_at": "2019-03-13T00:25:50.419-04:00",
"scheduled_at": "2019-02-21T12:00:00.000-05:00",
"published_at": null,
"excerpt": "In this Blender tutorial course, we’ll be using Meshroom, a free photogrammetry software, and Blender 3D to create a realistic 3D scanned pumpkin!\t",
"free": true,
"questions_enabled": true
},
{
"id": 6,
"title": "Fundamentals of Lighting in Unity",
"slug": "fundamentals-of-lighting-in-unity",
"status": "published",
"created_at": "2019-02-22T11:17:18.814-05:00",
"updated_at": "2019-02-22T11:37:17.599-05:00",
"scheduled_at": "2019-02-21T12:00:00.000-05:00",
"published_at": null,
"excerpt": "Learn the fundamentals of global illumination in Unity. Adjust ambient lighting, skyboxes, lightmaps then take a look at the individual lights to improve the mood of your game.",
"free": false,
"questions_enabled": true
}
]

get
Show Course

https://yoursite.mavenseed.com/api/v1/courses/:id
Retrieve a single course
Request
Response
Request
Headers
Authorization
required
string
Auth token
Response
200: OK
{
"id": 5,
"title": "Creating a Realistic 3D Photo Scanned Pumpkin",
"slug": "creating-a-realistic-3d-photo-scanned-pumpkin",
"status": "published",
"created_at": "2019-02-20T14:15:01.393-05:00",
"updated_at": "2019-03-13T00:25:50.419-04:00",
"scheduled_at": "2019-02-21T12:00:00.000-05:00",
"published_at": null,
"excerpt": "In this Blender tutorial course, we’ll be using Meshroom, a free photogrammetry software, and Blender 3D to create a realistic 3D scanned pumpkin!\t",
"free": true,
"questions_enabled": true
}
404: Not Found
null

post
Create Course

https://yoursite.mavenseed.com/v1/courses
Create a course.
Request
Response
Request
Headers
Authorization
required
string
Auth Token
Form Data Parameters
title
required
string
Title of the course
slug
required
string
Course slug, automatically created from title
status
required
integer
0 - draft, 1 - published
scheduled_at
optional
string
Optional datetime if course is scheduled
published_at
optional
string
Published date in datetime format
excerpt
optional
string
Course excerpt
free
optional
boolean
Whether or not the course is free
questions_enabled
optional
boolean
Should questions be enabled on the course
Response
200: OK
{
"id": 5,
"title": "Creating a Realistic 3D Photo Scanned Pumpkin",
"slug": "creating-a-realistic-3d-photo-scanned-pumpkin",
"status": "published",
"created_at": "2019-02-20T14:15:01.393-05:00",
"updated_at": "2019-03-13T00:25:50.419-04:00",
"scheduled_at": "2019-02-21T12:00:00.000-05:00",
"published_at": null,
"excerpt": "In this Blender tutorial course, we’ll be using Meshroom, a free photogrammetry software, and Blender 3D to create a realistic 3D scanned pumpkin!\t",
"free": true,
"questions_enabled": true
}

patch
Update Course

https://yoursite.mavenseed.com/v1/courses/:id
Update a single course. All of the above properties in create course are valid.
Request
Response
Request
Headers
Authorization
optional
string
Auth token
Response
200: OK
{
"id": 5,
"title": "Creating a Realistic 3D Photo Scanned Pumpkin",
"slug": "creating-a-realistic-3d-photo-scanned-pumpkin",
"status": "published",
"created_at": "2019-02-20T14:15:01.393-05:00",
"updated_at": "2019-03-13T00:25:50.419-04:00",
"scheduled_at": "2019-02-21T12:00:00.000-05:00",
"published_at": null,
"excerpt": "In this Blender tutorial course, we’ll be using Meshroom, a free photogrammetry software, and Blender 3D to create a realistic 3D scanned pumpkin!\t",
"free": true,
"questions_enabled": true
}

delete
Delete a Course

https://yoursite.mavenseed.com/v1/courses/:id
Delete a course.
Request
Response
Request
Headers
Authorization
required
string
Auth toke
Response
200: OK