References

Courses Resources

Endpoints

GET
https://api.upcoach.com/courses
List courses

Returns a list of courses

Parameters
Query
filter[user] *

Enrollerd user ID

filter[program]

Program ID

Responses
200: OK

A paginated list of Course Resource Objects

{
    "data": [
      {
        "id": "...",
        "description": "...",                           },
    ...
  ],
  "links": {
    "first": "...",
    "last": "...",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": ...,
    "from": ...,
    "last_page": ...,
    "path": "...",
    "per_page": ...,
    "to": ...,
    "total": ...
  }
}

Resource Objects

Course

Property

Type

Description

id

string

Course ID

name

string

Name

description

string

Description

image_url

string

Image URL

enrolled_at

integer

Enrollment date for user

completed_at

integer|null

The date user completed the course

progress_percentage

integer

Course progress percentage

completed_lesson_count

integer

Total number of lessons user completed

lesson_count

integer

Total number of lessons available in the course

module_count

integer

Total number of modules available in the course

link

string

Course link

Simple Course

Property

Type

Description

id

string

Course ID

name

string

Name

Previous
Tasks Resources