SchoolKeep API Documentation

Introduction

The SchoolKeep API is organized around REST and JSON-API. JSON is returned by all API responses, including errors.

Authentication

To use your API key, append to any API request.

GET https://api.schoolkeep.com/v1/courses?api_key=API_KEY

All API requests must be made over HTTPS. API requests without authentication will also fail.


Errors

SchoolKeep uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided. SchoolKeep will follow the JSON-API error spec when encountering an error.

An example error response is as follows:

Status

422

Body

{
  "errors": [
    {
      "status": "422",
      "title": "Invalid Attribute",
      "detail": "Uh oh, that name has already been added",
      "source": {
        "pointer": "/data/attributes/name"
      }
    }
  ]
}

Pagination

All top-level API resources have support for bulk fetches via "list" API methods. For instance you can list people, courses, and groups. These list API methods share a common structure, taking at least these two parameters: page and limit. SchoolKeep utilizes offset-based pagination via the page and limit parameters.

To use pagination, append to any "list" API request.

GET https://api.schoolkeep.com/v1/courses?page=2&limit=10

Pagination links appear in the links object that corresponds to a collection, as described by JSON-API. Pagination keys will be omitted to indicate that a particular link is unavailable.

An example of pagination links included in the returned JSON is as follows:

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/courses?page=2",
    "prev": "https://api.schoolkeep.com/v1/courses",
    "next": "https://api.schoolkeep.com/v1/courses?page=3"
  }
}


Analytics

List course progress analytics

Returns course progress at a per learner level

Endpoint

GET /v1/analytics/courses

Parameters

Name Description
page Page to view
limit Rows per page
q Query term, filters by learner details or course name

Request

Route

GET https://api.schoolkeep.com/v1/analytics/courses

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/analytics/courses"
  },
  "data": [
    {
      "type": "course_analytics",
      "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31:ea210647-aa59-49c1-85d1-5cae0ea6eed0:b55383d5-7c70-4231-bf01-b3c50aabf0b9",
      "attributes": {
        "enrolled_at": "2016-07-15T13:44:09.034Z",
        "last_activity_completed_at": null,
        "progress": 0
      },
      "relationships": {
        "course": {
          "data": {
            "type": "courses",
            "id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0"
          }
        },
        "course_attempt": {
          "data": {
            "type": "course_attempts",
            "id": "b55383d5-7c70-4231-bf01-b3c50aabf0b9"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
          }
        }
      }
    },
    {
      "type": "course_analytics",
      "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31:ae84c10c-31d4-4c16-bf25-9c37ecbc6632:00000000-0000-0000-0000-000000000000",
      "attributes": {
        "enrolled_at": "2016-07-15T13:44:09.038Z",
        "last_activity_completed_at": null,
        "progress": 0
      },
      "relationships": {
        "course": {
          "data": {
            "type": "courses",
            "id": "ae84c10c-31d4-4c16-bf25-9c37ecbc6632"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
          }
        }
      }
    }
  ]
}

List quiz score analytics

Returns quiz scores at a per learner level

Endpoint

GET /v1/analytics/quiz_scores

Parameters

Name Description
page Page to view
limit Rows per page
q Query term, filters by learner details, course name, quiz name or activity title

Request

Route

GET https://api.schoolkeep.com/v1/analytics/quiz_scores

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/analytics/quiz_scores"
  },
  "data": [
    {
      "type": "quiz_scores",
      "id": 13,
      "attributes": {
        "course_attempt_number": 1,
        "last_question_answered_at": "2016-07-15T13:49:34Z",
        "percent_correct": 0,
        "progress": 33,
        "questions_completed": "1/3"
      },
      "relationships": {
        "course": {
          "data": {
            "type": "courses",
            "id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
          }
        },
        "quiz": {
          "data": {
            "type": "quizzes",
            "id": "26a16c13-f969-406a-8f6b-9501ac9d2cff"
          }
        },
        "activity": {
          "data": {
            "type": "activities",
            "id": "fda134f4-9d8f-4cb5-852c-ef113fb4256f"
          }
        }
      }
    },
    {
      "type": "quiz_scores",
      "id": 14,
      "attributes": {
        "course_attempt_number": 1,
        "last_question_answered_at": "2016-07-15T13:49:34Z",
        "percent_correct": 0,
        "progress": 33,
        "questions_completed": "1/3"
      },
      "relationships": {
        "course": {
          "data": {
            "type": "courses",
            "id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "0a5318a7-72fc-488b-af0f-7b82991dabbe"
          }
        },
        "quiz": {
          "data": {
            "type": "quizzes",
            "id": "26a16c13-f969-406a-8f6b-9501ac9d2cff"
          }
        },
        "activity": {
          "data": {
            "type": "activities",
            "id": "72d69bb7-a5e4-4b32-85f3-6532fb5f1bdf"
          }
        }
      }
    }
  ]
}

List quiz raw answers analytics

Returns quiz answers at a per learner level

Endpoint

GET /v1/analytics/quiz_raw_answers

Parameters

Name Description
page Page to view
limit Rows per page
q Query term, filters by learner details, course name, quiz name or activity title

Request

Route

GET https://api.schoolkeep.com/v1/analytics/quiz_raw_answers

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/analytics/quiz_raw_answers"
  },
  "data": [
    {
      "type": "quiz_raw_answers",
      "id": "b9b7f542-ac09-494c-aa14-bcdba9a18144:681ad5cd-fa07-41c7-8224-a20a15c17ba7",
      "attributes": {
        "activity_title": "Investing 101",
        "course_attempt_number": 1,
        "course_name": "SchoolKeep Onboarding",
        "date_answered": "2016-12-02T19:09:09.649Z",
        "marked_correct": false,
        "question_number": "1/3",
        "question_text": "Question (18)",
        "quiz_name": "Finance Quiz",
        "response": "New Answer"
      },
      "relationships": {
        "person": {
          "data": {
            "type": "people",
            "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
          }
        }
      }
    },
    {
      "type": "quiz_raw_answers",
      "id": "fe75b8a9-3cba-4eee-8e0f-57f8b413fbd5:681ad5cd-fa07-41c7-8224-a20a15c17ba7",
      "attributes": {
        "activity_title": "Physics 101",
        "course_attempt_number": 1,
        "course_name": "SchoolKeep Onboarding",
        "date_answered": "2016-12-02T19:09:09.672Z",
        "marked_correct": false,
        "question_number": "1/3",
        "question_text": "Question (18)",
        "quiz_name": "Finance Quiz",
        "response": "New Answer"
      },
      "relationships": {
        "person": {
          "data": {
            "type": "people",
            "id": "0a5318a7-72fc-488b-af0f-7b82991dabbe"
          }
        }
      }
    }
  ]
}

Assignments

List all assignments

Returns a list of assignments. The assignments are returned in sorted order, alphabetically, by assignment title.

Endpoint

GET /v1/assignments

Parameters

Name Description
page Page to view
limit Assignments per page
q Query term, filters by assignments name

Request

Route

GET https://api.schoolkeep.com/v1/assignments

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/assignments"
  },
  "data": [
    {
      "type": "assignments",
      "id": "277f4d79-72eb-4c5c-9f40-25b6e94ca49a",
      "attributes": {
        "title": "Assignment #1: Tell us about yourself",
        "created_at": "2016-01-02T03:04:05Z"
      },
      "links": {
        "teaching": "https://app.schoolkeep.com/assignments/165"
      }
    },
    {
      "type": "assignments",
      "id": "0a932514-57b1-4d05-927e-47878a842fe2",
      "attributes": {
        "title": "Assignment #2: Share your favorite photo",
        "created_at": "2016-01-02T03:04:05Z"
      },
      "links": {
        "teaching": "https://app.schoolkeep.com/assignments/166"
      }
    }
  ]
}

Bulk/Groups

Bulk create groups for the school

Endpoint

POST /v1/bulk/groups

Parameters

Name Description
data[type] Required Data type
data[attributes][groups] Required Data attributes groups

Request

Route

POST https://api.schoolkeep.com/v1/bulk/groups

Body

{
  "data": {
    "attributes": {
      "groups": [
        {
          "name": "Foo Group",
          "courses": "ea210647-aa59-49c1-85d1-5cae0ea6eed0"
        },
        {
          "name": "Foo Group",
          "courses": "b685091b-6f65-4c20-9ba8-132b5ffbddde"
        },
        {
          "name": "Bar Group",
          "courses": "b685091b-6f65-4c20-9ba8-132b5ffbddde"
        }
      ]
    }
  }
}

Response

Status

202

Bulk/People

Bulk invite people to a school

Endpoint

POST /v1/bulk/people

Parameters

Name Description
data[type] Required Data type
data[attributes][people] Required Data attributes people

Request

Route

POST https://api.schoolkeep.com/v1/bulk/people

Body

{
  "data": {
    "attributes": {
      "people": [
        {
          "email": "foo@example.com",
          "groups": "Foo Group"
        },
        {
          "email": "foo@example.com",
          "groups": "Bar Group"
        },
        {
          "email": "bar@example.com",
          "groups": "Bar Group"
        }
      ]
    }
  }
}

Response

Status

202

Categories

List categories

Returns a list of categories.

Endpoint

GET /v1/categories

Parameters

Name Description
page Page to view
limit Categories per page
q Query term, filters by category name

Request

Route

GET https://api.schoolkeep.com/v1/categories

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/categories"
  },
  "data": [
    {
      "type": "categories",
      "id": "a945456c-e54d-4730-82c0-07fc1ddfabfd",
      "attributes": {
        "name": "Science",
        "created_at": "2016-01-02T03:04:05Z",
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/categories/a945456c-e54d-4730-82c0-07fc1ddfabfd"
      }
    },
    {
      "type": "categories",
      "id": "8270f668-fab9-4d4c-9008-0c08fa87e2bf",
      "attributes": {
        "name": "Finance",
        "created_at": "2016-01-02T03:04:05Z",
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/categories/8270f668-fab9-4d4c-9008-0c08fa87e2bf"
      }
    }
  ]
}

Retrieve a category

Retrieves the details of a category. You only need to supply the unique category identifier.

Endpoint

GET /v1/categories/:uuid

Parameters

Name Description
uuid Required uuid

Request

Route

GET https://api.schoolkeep.com/v1/categories/8270f668-fab9-4d4c-9008-0c08fa87e2bf

Response

Status

200

Body

{
  "data": {
    "type": "categories",
    "id": "8270f668-fab9-4d4c-9008-0c08fa87e2bf",
    "attributes": {
      "name": "Finance",
      "created_at": "2016-01-02T03:04:05Z",
      "updated_at": "2016-02-03T04:05:06Z"
    },
    "links": {
      "self": "https://api.schoolkeep.com/v1/categories/8270f668-fab9-4d4c-9008-0c08fa87e2bf"
    }
  }
}

Create a category

Creates a new category.

Endpoint

POST /v1/categories

Parameters

Name Description
data[type] Required Data type
data[attributes][name] Required Data attributes name

Request

Route

POST https://api.schoolkeep.com/v1/categories

Body

{
  "data": {
    "type": "categories",
    "attributes": {
      "name": "Computer Software"
    }
  }
}

Response

Status

201

Body

{
  "data": {
    "type": "categories",
    "id": "ca0c4f3b-34ea-4111-b77a-b9afed4766be",
    "attributes": {
      "name": "Computer Software",
      "created_at": "2016-02-03T04:05:06Z",
      "updated_at": "2016-02-03T04:05:06Z"
    },
    "links": {
      "self": "https://api.schoolkeep.com/v1/categories/ca0c4f3b-34ea-4111-b77a-b9afed4766be"
    }
  }
}

Update a category

Updates the specified category by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Endpoint

PATCH /v1/categories/:uuid

Parameters

Name Description
data[type] Required Data type
data[uuid] Required Data uuid
data[attributes][name] Data attributes name

Request

Route

PATCH https://api.schoolkeep.com/v1/categories/8270f668-fab9-4d4c-9008-0c08fa87e2bf

Body

{
  "data": {
    "type": "categories",
    "uuid": "8270f668-fab9-4d4c-9008-0c08fa87e2bf",
    "attributes": {
      "name": "Business"
    }
  }
}

Response

Status

200

Body

{
  "data": {
    "type": "categories",
    "id": "8270f668-fab9-4d4c-9008-0c08fa87e2bf",
    "attributes": {
      "name": "Business",
      "created_at": "2016-01-02T03:04:05Z",
      "updated_at": "2016-02-03T04:05:06Z"
    },
    "links": {
      "self": "https://api.schoolkeep.com/v1/categories/8270f668-fab9-4d4c-9008-0c08fa87e2bf"
    }
  }
}

Delete a category

Permanently deletes a category. It cannot be undone.

Endpoint

DELETE /v1/categories/:uuid

Parameters

Name Description
data[type] Required Data type
data[uuid] Required Data uuid

Request

Route

DELETE https://api.schoolkeep.com/v1/categories/8270f668-fab9-4d4c-9008-0c08fa87e2bf

Body

{
  "data": {
    "type": "categories",
    "uuid": "8270f668-fab9-4d4c-9008-0c08fa87e2bf"
  }
}

Response

Status

204

Coupons

List coupons

Returns a list of coupons. The coupons are returned in sorted order, alphabetically, by coupon code.

Endpoint

GET /v1/coupons

Parameters

Name Description
page Page to view
limit Coupons per page
q Query term, filters by coupon name

Request

Route

GET https://api.schoolkeep.com/v1/coupons

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/coupons"
  },
  "data": [
    {
      "type": "coupons",
      "id": "821d114a-52e0-4842-a19b-047d483bfb2c",
      "attributes": {
        "code": "BLACKFRIDAY",
        "currency_code": "USD",
        "enabled": true,
        "end_on": null,
        "format": "fixed",
        "start_on": "2016-12-27",
        "usages_count": 0,
        "maximum_usages": 100,
        "value": 100
      },
      "relationships": {
      },
      "links": {
        "self": {
          "href": "https://api.schoolkeep.com/v1/coupons/821d114a-52e0-4842-a19b-047d483bfb2c",
          "methods": [
            "get",
            "post",
            "delete"
          ]
        },
        "activation": "https://api.schoolkeep.com/v1/coupons/821d114a-52e0-4842-a19b-047d483bfb2c/activation",
        "teaching": "https://app.schoolkeep.com/coupons/94"
      }
    },
    {
      "type": "coupons",
      "id": "5dbe004b-acc3-4046-9832-ecf9b82e921b",
      "attributes": {
        "code": "FALLSALE",
        "currency_code": "USD",
        "enabled": false,
        "end_on": null,
        "format": "fixed",
        "start_on": "2016-12-27",
        "usages_count": 0,
        "maximum_usages": 100,
        "value": 100
      },
      "relationships": {
      },
      "links": {
        "self": {
          "href": "https://api.schoolkeep.com/v1/coupons/5dbe004b-acc3-4046-9832-ecf9b82e921b",
          "methods": [
            "get",
            "post",
            "delete"
          ]
        },
        "activation": "https://api.schoolkeep.com/v1/coupons/5dbe004b-acc3-4046-9832-ecf9b82e921b/activation",
        "teaching": "https://app.schoolkeep.com/coupons/93"
      }
    }
  ]
}

Delete a coupon

Permanently deletes a coupon. It cannot be undone.

Endpoint

DELETE /v1/coupons/:uuid

Parameters

Name Description
data[type] Required Data type
data[uuid] Required Data uuid

Request

Route

DELETE https://api.schoolkeep.com/v1/coupons/5dbe004b-acc3-4046-9832-ecf9b82e921b

Body

{
  "data": {
    "type": "coupons",
    "uuid": "5dbe004b-acc3-4046-9832-ecf9b82e921b"
  }
}

Response

Status

204

Activates the coupon

Endpoint

POST /v1/coupons/:uuid/activation

Request

Route

POST https://api.schoolkeep.com/v1/coupons/5dbe004b-acc3-4046-9832-ecf9b82e921b/activation

Response

Status

204

Deactivates the coupon

Endpoint

DELETE /v1/coupons/:uuid/activation

Request

Route

DELETE https://api.schoolkeep.com/v1/coupons/821d114a-52e0-4842-a19b-047d483bfb2c/activation

Response

Status

204

Courses

List courses

Returns a list of courses. The courses are returned in sorted order, alphabetically, by course name.

Endpoint

GET /v1/courses

Parameters

Name Description
page Page to view
limit Courses per page
q Query term, filters by course name

Request

Route

GET https://api.schoolkeep.com/v1/courses

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/courses"
  },
  "data": [
    {
      "type": "courses",
      "id": "b685091b-6f65-4c20-9ba8-132b5ffbddde",
      "attributes": {
        "name": "Design and Market Your School Site",
        "enrollments_count": 0,
        "course_enrollment_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-137.schoolkeep.com/c/84775ef90d8c8a44777b748f19ea86bd02e163e8",
        "share_course_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-137.schoolkeep.com/outline/qjcud6ho/cover",
        "permalink": "qjcud6ho",
        "created_at": "2016-01-02T03:04:05Z",
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "relationships": {
        "categories": {
          "data": [
            {
              "type": "categories",
              "id": "8270f668-fab9-4d4c-9008-0c08fa87e2bf"
            },
            {
              "type": "categories",
              "id": "a945456c-e54d-4730-82c0-07fc1ddfabfd"
            }
          ]
        },
        "instructor_partnerships": {
          "data": [

          ]
        }
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/courses/qjcud6ho",
        "teaching": "https://app.schoolkeep.com/courses/qjcud6ho",
        "build": "https://app.schoolkeep.com/courses/qjcud6ho/builder"
      }
    },
    {
      "type": "courses",
      "id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0",
      "attributes": {
        "name": "SchoolKeep Onboarding",
        "enrollments_count": 0,
        "course_enrollment_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-137.schoolkeep.com/c/858eac837396df8d5eda69e1bcf767f68dae6871",
        "share_course_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-137.schoolkeep.com/outline/f24cj7q3/cover",
        "permalink": "f24cj7q3",
        "created_at": "2016-01-02T03:04:05Z",
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "relationships": {
        "categories": {
          "data": [
            {
              "type": "categories",
              "id": "8270f668-fab9-4d4c-9008-0c08fa87e2bf"
            }
          ]
        },
        "instructor_partnerships": {
          "data": [

          ]
        }
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/courses/f24cj7q3",
        "teaching": "https://app.schoolkeep.com/courses/f24cj7q3",
        "build": "https://app.schoolkeep.com/courses/f24cj7q3/builder"
      }
    },
    {
      "type": "courses",
      "id": "ae84c10c-31d4-4c16-bf25-9c37ecbc6632",
      "attributes": {
        "name": "Sell Content with the Commerce Tool",
        "enrollments_count": 0,
        "course_enrollment_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-137.schoolkeep.com/c/78510398fb412cf491ca054449af812cced11302",
        "share_course_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-137.schoolkeep.com/outline/s3p9kahv/cover",
        "permalink": "s3p9kahv",
        "created_at": "2016-01-02T03:04:05Z",
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "relationships": {
        "categories": {
          "data": [

          ]
        },
        "instructor_partnerships": {
          "data": [

          ]
        }
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/courses/s3p9kahv",
        "teaching": "https://app.schoolkeep.com/courses/s3p9kahv",
        "build": "https://app.schoolkeep.com/courses/s3p9kahv/builder"
      }
    }
  ],
  "included": [

  ]
}

Retrieve a course

Retrieves the details of a course. You only need to supply the unique course identifier.

Endpoint

GET /v1/courses/:id

Parameters

Name Description
id Required id

Request

Route

GET https://api.schoolkeep.com/v1/courses/ea210647-aa59-49c1-85d1-5cae0ea6eed0

Response

Status

200

Body

{
  "data": {
    "type": "courses",
    "id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0",
    "attributes": {
      "name": "SchoolKeep Onboarding",
      "course_enrollment_link": "http://school-7dfe7623-6861-4920-9959-4295819bfd6a-138.schoolkeep.com/c/ae1a337c94977e9fed53afeb41d03e29d7538d25",
      "share_course_link": "http://school-7dfe7623-6861-4920-9959-4295819bfd6a-138.schoolkeep.com/outline/f24cj7q3/cover",
      "permalink": "f24cj7q3",
      "created_at": "2016-01-02T03:04:05Z",
      "updated_at": "2016-02-03T04:05:06Z"
    },
    "relationships": {
      "categories": {
        "data": [
          {
            "type": "categories",
            "id": "8270f668-fab9-4d4c-9008-0c08fa87e2bf"
          }
        ]
      },
      "instructor_partnerships": {
        "data": [

        ]
      }
    },
    "links": {
      "self": "https://api.schoolkeep.com/v1/courses/f24cj7q3",
      "teaching": "https://app.schoolkeep.com/courses/f24cj7q3",
      "build": "https://app.schoolkeep.com/courses/f24cj7q3/builder"
    }
  }
}

Groups

List groups

Returns a list of groups. The groups are returned in sorted order, alphabetically, by group title.

Endpoint

GET /v1/groups

Parameters

Name Description
page Page to view
limit Groups per page
q Query term, filters by groups name

Request

Route

GET https://api.schoolkeep.com/v1/groups

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/groups"
  },
  "data": [
    {
      "type": "groups",
      "id": "01beba5d-3fb1-441f-a333-c9fd043fe5ce",
      "attributes": {
        "name": "Designers",
        "membership_count": 0,
        "created_at": "2016-01-02T03:04:05Z",
        "updated_at": "2016-02-03T04:05:06Z",
        "group_enrollment_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-141.schoolkeep.com/g/e342acfffff1ef9f9ff661a631c58a26020a412e"
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/groups/01beba5d-3fb1-441f-a333-c9fd043fe5ce",
        "teaching": "https://app.schoolkeep.com/groups/247",
        "memberships": "https://app.schoolkeep.com/groups/247/memberships"
      }
    },
    {
      "type": "groups",
      "id": "b3914dd8-4199-4716-bc6f-e66b541b86ba",
      "attributes": {
        "name": "Engineers",
        "membership_count": 1,
        "created_at": "2016-01-02T03:04:05Z",
        "updated_at": "2016-02-03T04:05:06Z",
        "group_enrollment_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-141.schoolkeep.com/g/3734f266d2d068666f88f1305c4531499c329cb9"
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/groups/b3914dd8-4199-4716-bc6f-e66b541b86ba",
        "teaching": "https://app.schoolkeep.com/groups/246",
        "memberships": "https://app.schoolkeep.com/groups/246/memberships"
      }
    },
    {
      "type": "groups",
      "id": "77e08c5f-84f2-49df-8e80-0fae3e374be0",
      "attributes": {
        "name": "Managers",
        "membership_count": 1,
        "created_at": "2016-01-02T03:04:05Z",
        "updated_at": "2016-02-03T04:05:06Z",
        "group_enrollment_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-141.schoolkeep.com/g/42f6fde7c1709e43b57f9e808bc3b92de7cc5c7b"
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/groups/77e08c5f-84f2-49df-8e80-0fae3e374be0",
        "teaching": "https://app.schoolkeep.com/groups/245",
        "memberships": "https://app.schoolkeep.com/groups/245/memberships"
      }
    }
  ]
}

Retrieve a group

Retrieves the details of a group. You only need to supply the unique group identifier.

Endpoint

GET /v1/groups/:uuid

Parameters

Name Description
uuid Required uuid

Request

Route

GET https://api.schoolkeep.com/v1/groups/b3914dd8-4199-4716-bc6f-e66b541b86ba

Response

Status

200

Body

{
  "data": {
    "type": "groups",
    "id": "b3914dd8-4199-4716-bc6f-e66b541b86ba",
    "attributes": {
      "name": "Engineers",
      "created_at": "2016-01-02T03:04:05Z",
      "updated_at": "2016-02-03T04:05:06Z",
      "group_enrollment_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-142.schoolkeep.com/g/d1fbb2191078c8ac0544bfdf03443a1affa4a3f3"
    },
    "links": {
      "self": "https://api.schoolkeep.com/v1/groups/b3914dd8-4199-4716-bc6f-e66b541b86ba",
      "teaching": "https://app.schoolkeep.com/groups/249",
      "memberships": "https://app.schoolkeep.com/groups/249/memberships"
    }
  }
}

Create a group

Creates a new group.

Endpoint

POST /v1/groups

Parameters

Name Description
data[type] Required Data type
data[attributes][name] Required Data attributes name

Request

Route

POST https://api.schoolkeep.com/v1/groups

Body

{
  "data": {
    "type": "groups",
    "attributes": {
      "name": "Sales"
    }
  }
}

Response

Status

201

Body

{
  "data": {
    "type": "groups",
    "id": "4e070300-5690-4614-b149-8f457640eb30",
    "attributes": {
      "name": "Sales",
      "created_at": "2016-02-03T04:05:06Z",
      "updated_at": "2016-02-03T04:05:06Z",
      "group_enrollment_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-143.schoolkeep.com/g/ede1c9d808c43fe43c71a1de5bbe29905c562a03"
    },
    "links": {
      "self": "https://api.schoolkeep.com/v1/groups/4e070300-5690-4614-b149-8f457640eb30",
      "teaching": "https://app.schoolkeep.com/groups/254",
      "memberships": "https://app.schoolkeep.com/groups/254/memberships"
    }
  }
}

Update a group

Updates the specified group by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Endpoint

PATCH /v1/groups/:uuid

Parameters

Name Description
data[type] Required Data type
data[uuid] Required Data uuid
data[attributes][name] Data attributes name

Request

Route

PATCH https://api.schoolkeep.com/v1/groups/b3914dd8-4199-4716-bc6f-e66b541b86ba

Body

{
  "data": {
    "type": "groups",
    "uuid": "b3914dd8-4199-4716-bc6f-e66b541b86ba",
    "attributes": {
      "name": "Developers"
    }
  }
}

Response

Status

200

Body

{
  "data": {
    "type": "groups",
    "id": "b3914dd8-4199-4716-bc6f-e66b541b86ba",
    "attributes": {
      "name": "Developers",
      "created_at": "2016-01-02T03:04:05Z",
      "updated_at": "2016-02-03T04:05:06Z",
      "group_enrollment_link": "http://school-27abf21e-397d-463a-b93e-4d75812085ee-144.schoolkeep.com/g/dcd4a8dc1042330ae686bf8865c49cf2c631364a"
    },
    "links": {
      "self": "https://api.schoolkeep.com/v1/groups/b3914dd8-4199-4716-bc6f-e66b541b86ba",
      "teaching": "https://app.schoolkeep.com/groups/256",
      "memberships": "https://app.schoolkeep.com/groups/256/memberships"
    }
  }
}

Add a course to a group

Add existing courses to an existing group. This will add any courses that are not in the group, and ignore any courses that are already in the group. You do not have to include any courses that are already present, as this will not remove any current relationships.

Endpoint

POST /v1/groups/:group_uuid/relationships/courses

Parameters

Name Description
group_uuid Required group uuid
data[type] Required Data type
data[id] Required Data id

Request

Route

POST https://api.schoolkeep.com/v1/groups/77e08c5f-84f2-49df-8e80-0fae3e374be0/relationships/courses

Body

{
  "data": [
    {
      "type": "courses",
      "id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0"
    }
  ]
}

Response

Status

204

Add a person to a group

Add existing people to an existing group. This will add any people that are not in the group, and ignore any people that are already in the group. You do not have to include any people that are already present, as this will not remove any current relationships.

Endpoint

POST /v1/groups/:group_uuid/relationships/people

Parameters

Name Description
group_uuid Required group uuid
data[type] Required Data type
data[id] Required Data id

Request

Route

POST https://api.schoolkeep.com/v1/groups/77e08c5f-84f2-49df-8e80-0fae3e374be0/relationships/people

Body

{
  "data": [
    {
      "type": "people",
      "id": "0a5318a7-72fc-488b-af0f-7b82991dabbe"
    }
  ]
}

Response

Status

204

Delete a group

Permanently deletes a group. It cannot be undone.

Endpoint

DELETE /v1/groups/:uuid

Parameters

Name Description
data[type] Required Data type
data[uuid] Required Data uuid

Request

Route

DELETE https://api.schoolkeep.com/v1/groups/77e08c5f-84f2-49df-8e80-0fae3e374be0

Body

{
  "data": {
    "type": "groups",
    "uuid": "77e08c5f-84f2-49df-8e80-0fae3e374be0"
  }
}

Response

Status

204

Learners

List learners

Returns a list of learners. The learners are returned in sorted order, alphabetically, by learners full name.

Endpoint

GET /v1/learners

Parameters

Name Description
page Page to view
limit Learners per page
q Query term, filters by learner name

Request

Route

GET https://api.schoolkeep.com/v1/learners

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/learners"
  },
  "data": [
    {
      "type": "learners",
      "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31",
      "attributes": {
        "course_count": 0,
        "email": "api+einstein@schoolkeep.com",
        "full_name": "Albert Einstein",
        "group_count": 0,
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "links": {
        "self": {
          "href": "https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31",
          "methods": [
            "get",
            "delete"
          ]
        },
        "teaching": "https://app.schoolkeep.com/people/1668"
      }
    },
    {
      "type": "learners",
      "id": "0a5318a7-72fc-488b-af0f-7b82991dabbe",
      "attributes": {
        "course_count": 0,
        "email": "api+curie@schoolkeep.com",
        "full_name": "Marie Curie",
        "group_count": 0,
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "links": {
        "self": {
          "href": "https://api.schoolkeep.com/v1/people/0a5318a7-72fc-488b-af0f-7b82991dabbe",
          "methods": [
            "get",
            "delete"
          ]
        },
        "teaching": "https://app.schoolkeep.com/people/1669"
      }
    },
    {
      "type": "learners",
      "id": "e598cb5b-d172-464b-93ec-0631fb491f1d",
      "attributes": {
        "course_count": 0,
        "email": "api+tesla@schoolkeep.com",
        "full_name": "Nikola Tesla",
        "group_count": 0,
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "links": {
        "self": {
          "href": "https://api.schoolkeep.com/v1/people/e598cb5b-d172-464b-93ec-0631fb491f1d",
          "methods": [
            "get"
          ]
        },
        "teaching": "https://app.schoolkeep.com/people/1667"
      }
    }
  ]
}

Fetch a learner

Retrieves the details of a learner. You only need to supply the unique learner identifier.

Endpoint

GET /v1/learners/:uuid

Parameters

Name Description
uuid Required uuid

Request

Route

GET https://api.schoolkeep.com/v1/learners/0a5318a7-72fc-488b-af0f-7b82991dabbe

Response

Status

200

Body

{
  "data": {
    "type": "learners",
    "id": "0a5318a7-72fc-488b-af0f-7b82991dabbe",
    "attributes": {
      "course_count": 0,
      "email": "api+curie@schoolkeep.com",
      "full_name": "Marie Curie",
      "group_count": 0,
      "updated_at": "2016-02-03T04:05:06Z"
    },
    "links": {
      "self": {
        "href": "https://api.schoolkeep.com/v1/people/0a5318a7-72fc-488b-af0f-7b82991dabbe",
        "methods": [
          "get",
          "delete"
        ]
      },
      "teaching": "https://app.schoolkeep.com/people/369"
    }
  }
}

Create a learner

Creates a new learner, and sends an invite.

If your school is using URL Authentication, this request will be forbidden.

Endpoint

POST /v1/learners

Parameters

Name Description
data[type] Required Data type
data[attributes][email] Required Data attributes email

Request

Route

POST https://api.schoolkeep.com/v1/learners

Body

{
  "data": {
    "type": "people",
    "attributes": {
      "email": "api+faraday@schoolkeep.com"
    }
  }
}

Response

Status

201

Body

{
  "data": {
    "type": "people",
    "id": "2119c6c9-31d5-485b-9f7a-2eb9159e8815",
    "attributes": {
      "created_at": "2016-02-03T04:05:06Z",
      "email": "api+faraday@schoolkeep.com",
      "updated_at": "2016-02-03T04:05:06Z"
    },
    "links": {
      "self": "https://api.schoolkeep.com/v1/people/2119c6c9-31d5-485b-9f7a-2eb9159e8815",
      "teaching": "https://app.schoolkeep.com/people/6720"
    }
  }
}

Delete a learner

Permanently deletes a learner. It cannot be undone.

Endpoint

DELETE /v1/learners/:uuid

Parameters

Name Description
data[uuid] Required Data uuid

Request

Route

DELETE https://api.schoolkeep.com/v1/learners/0a5318a7-72fc-488b-af0f-7b82991dabbe

Body

{
  "data": {
    "uuid": "0a5318a7-72fc-488b-af0f-7b82991dabbe"
  }
}

Response

Status

204

Memberships

Delete a membership

Permanently deletes a membership. It cannot be undone.

Endpoint

DELETE /v1/memberships/:uuid

Parameters

Name Description
data[uuid] Required Data uuid

Request

Route

DELETE https://api.schoolkeep.com/v1/memberships/45160321-e1d9-46bb-8f2f-94aab2552963

Body

{
  "data": {
    "uuid": "45160321-e1d9-46bb-8f2f-94aab2552963"
  }
}

Response

Status

204

People/AccessibleCourses

List courses

Returns a list of courses. The courses are returned in sorted order, alphabetically, by course name.

Endpoint

GET /v1/people/:person_uuid/accessible-courses

Parameters

Name Description
person_uuid Required person uuid
page Page to view
limit Courses per page
q Query term, filters by course name

Request

Route

GET https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31/accessible-courses

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31/accessible-courses"
  },
  "data": [
    {
      "type": "accessible_courses",
      "id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0:dba33949-18d3-4f7d-83ee-8de8c1370b31",
      "relationships": {
        "course": {
          "data": {
            "type": "courses",
            "id": "ea210647-aa59-49c1-85d1-5cae0ea6eed0"
          }
        },
        "partnerships": {
          "data": [
            {
              "type": "partnerships",
              "id": "04aca00c-57f4-4b5f-abc7-cdb587683b9b"
            }
          ]
        },
        "groups": {
          "data": [

          ]
        },
        "person": {
          "data": {
            "type": "people",
            "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
          }
        }
      },
      "attributes": {
        "not_deletable": false
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31/accessible-courses/ea210647-aa59-49c1-85d1-5cae0ea6eed0:dba33949-18d3-4f7d-83ee-8de8c1370b31",
        "teaching/course_permission_removals/new": "https://app.schoolkeep.com/people/dba33949-18d3-4f7d-83ee-8de8c1370b31/courses/ea210647-aa59-49c1-85d1-5cae0ea6eed0/permission_removal/new"
      }
    },
    {
      "type": "accessible_courses",
      "id": "ae84c10c-31d4-4c16-bf25-9c37ecbc6632:dba33949-18d3-4f7d-83ee-8de8c1370b31",
      "relationships": {
        "course": {
          "data": {
            "type": "courses",
            "id": "ae84c10c-31d4-4c16-bf25-9c37ecbc6632"
          }
        },
        "partnerships": {
          "data": [
            {
              "type": "partnerships",
              "id": "5914811c-b4c5-4ac4-9e6d-294c3b77d024"
            },
            {
              "type": "partnerships",
              "id": "04aca00c-57f4-4b5f-abc7-cdb587683b9b"
            }
          ]
        },
        "groups": {
          "data": [

          ]
        },
        "person": {
          "data": {
            "type": "people",
            "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
          }
        }
      },
      "attributes": {
        "not_deletable": false
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31/accessible-courses/ae84c10c-31d4-4c16-bf25-9c37ecbc6632:dba33949-18d3-4f7d-83ee-8de8c1370b31",
        "teaching/course_permission_removals/new": "https://app.schoolkeep.com/people/dba33949-18d3-4f7d-83ee-8de8c1370b31/courses/ae84c10c-31d4-4c16-bf25-9c37ecbc6632/permission_removal/new"
      }
    }
  ],
  "included": [

  ]
}

People/Memberships

List memberships

Returns a list of memberships.

Endpoint

GET /v1/people/:person_uuid/memberships

Parameters

Name Description
person_uuid Required person uuid
page Page to view
limit Memberships per page
q Query term, filters by course name

Request

Route

GET https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31/memberships

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31/memberships"
  },
  "data": [
    {
      "type": "memberships",
      "id": "45160321-e1d9-46bb-8f2f-94aab2552963",
      "attributes": {
        "course_count": 0
      },
      "relationships": {
        "group": {
          "data": {
            "type": "groups",
            "id": "b3914dd8-4199-4716-bc6f-e66b541b86ba"
          }
        },
        "partnership": {
          "data": {
            "type": "partnerships",
            "id": "04aca00c-57f4-4b5f-abc7-cdb587683b9b"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
          }
        }
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/memberships/45160321-e1d9-46bb-8f2f-94aab2552963"
      }
    },
    {
      "type": "memberships",
      "id": "8e7662ad-1329-4c7d-a9ce-445cc6bb1518",
      "attributes": {
        "course_count": 0
      },
      "relationships": {
        "group": {
          "data": {
            "type": "groups",
            "id": "77e08c5f-84f2-49df-8e80-0fae3e374be0"
          }
        },
        "partnership": {
          "data": {
            "type": "partnerships",
            "id": "04aca00c-57f4-4b5f-abc7-cdb587683b9b"
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31"
          }
        }
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/memberships/8e7662ad-1329-4c7d-a9ce-445cc6bb1518"
      }
    }
  ],
  "included": [

  ]
}

People/ResendInvite

Resends invitation email to person

Resends invitation email to person with uuid provided

Endpoint

POST /v1/people/:person_uuid/resend-invite

Parameters

Name Description
person_uuid Required person uuid

Request

Route

POST https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31/resend-invite

Response

Status

200

People

List people

Returns a list of people. The people are returned in sorted order, alphabetically, by full name.

Endpoint

GET /v1/people

Parameters

Name Description
page Page to view
limit People per page
q Query term, filters by people name

Request

Route

GET https://api.schoolkeep.com/v1/people

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/people"
  },
  "data": [
    {
      "type": "people",
      "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31",
      "attributes": {
        "course_count": 0,
        "created_at": "2016-01-02T03:04:05Z",
        "custom_avatar_url": null,
        "email": "api+einstein@schoolkeep.com",
        "full_name": "Albert Einstein",
        "group_count": 0,
        "registration_status": "registered",
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "links": {
        "self": {
          "href": "https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31",
          "methods": [
            "get",
            "delete"
          ]
        },
        "teaching": {
          "href": "https://app.schoolkeep.com/people/1697",
          "methods": [
            "get",
            "patch"
          ]
        }
      },
      "relationships": {
        "partnerships": {
          "data": [
            {
              "type": "partnerships",
              "id": "04aca00c-57f4-4b5f-abc7-cdb587683b9b"
            },
            {
              "type": "partnerships",
              "id": "5914811c-b4c5-4ac4-9e6d-294c3b77d024"
            }
          ]
        }
      }
    },
    {
      "type": "people",
      "id": "0a5318a7-72fc-488b-af0f-7b82991dabbe",
      "attributes": {
        "course_count": 0,
        "created_at": "2016-01-02T03:04:05Z",
        "custom_avatar_url": null,
        "email": "api+curie@schoolkeep.com",
        "full_name": "Marie Curie",
        "group_count": 0,
        "registration_status": "registered",
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "links": {
        "self": {
          "href": "https://api.schoolkeep.com/v1/people/0a5318a7-72fc-488b-af0f-7b82991dabbe",
          "methods": [
            "get",
            "delete"
          ]
        },
        "teaching": {
          "href": "https://app.schoolkeep.com/people/1698",
          "methods": [
            "get",
            "patch"
          ]
        }
      },
      "relationships": {
        "partnerships": {
          "data": [
            {
              "type": "partnerships",
              "id": "ad727cdf-d74e-4924-b0b7-73bfe7da2c00"
            },
            {
              "type": "partnerships",
              "id": "06f2769b-248a-4b0f-a044-5b495da47302"
            }
          ]
        }
      }
    },
    {
      "type": "people",
      "id": "e598cb5b-d172-464b-93ec-0631fb491f1d",
      "attributes": {
        "course_count": 0,
        "created_at": "2016-01-02T03:04:05Z",
        "custom_avatar_url": null,
        "email": "api+tesla@schoolkeep.com",
        "full_name": "Nikola Tesla",
        "group_count": 0,
        "registration_status": "registered",
        "updated_at": "2016-02-03T04:05:06Z"
      },
      "links": {
        "self": {
          "href": "https://api.schoolkeep.com/v1/people/e598cb5b-d172-464b-93ec-0631fb491f1d",
          "methods": [
            "get"
          ]
        },
        "teaching": {
          "href": "https://app.schoolkeep.com/people/1696",
          "methods": [
            "get",
            "patch"
          ]
        }
      },
      "relationships": {
        "partnerships": {
          "data": [
            {
              "type": "partnerships",
              "id": "2ac51609-ea8a-4f7b-b721-2cf3e0725bac"
            },
            {
              "type": "partnerships",
              "id": "41cad80f-dafa-4b5a-861e-aab58278d096"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "partnerships",
      "id": "04aca00c-57f4-4b5f-abc7-cdb587683b9b",
      "attributes": {
        "role": "Learner"
      },
      "links": {
        "teaching": "https://app.schoolkeep.com/people/1697"
      }
    },
    {
      "type": "partnerships",
      "id": "5914811c-b4c5-4ac4-9e6d-294c3b77d024",
      "attributes": {
        "role": "Instructor"
      },
      "links": {
        "teaching": "https://app.schoolkeep.com/people/1697"
      }
    },
    {
      "type": "partnerships",
      "id": "ad727cdf-d74e-4924-b0b7-73bfe7da2c00",
      "attributes": {
        "role": "Learner"
      },
      "links": {
        "teaching": "https://app.schoolkeep.com/people/1698"
      }
    },
    {
      "type": "partnerships",
      "id": "06f2769b-248a-4b0f-a044-5b495da47302",
      "attributes": {
        "role": "Instructor"
      },
      "links": {
        "teaching": "https://app.schoolkeep.com/people/1698"
      }
    },
    {
      "type": "partnerships",
      "id": "2ac51609-ea8a-4f7b-b721-2cf3e0725bac",
      "attributes": {
        "role": "Admin"
      },
      "links": {
        "teaching": "https://app.schoolkeep.com/people/1696"
      }
    },
    {
      "type": "partnerships",
      "id": "41cad80f-dafa-4b5a-861e-aab58278d096",
      "attributes": {
        "role": "Learner"
      },
      "links": {
        "teaching": "https://app.schoolkeep.com/people/1696"
      }
    }
  ]
}

Fetch a person

Retrieves the details of a person. You only need to supply the unique person identifier.

Endpoint

GET /v1/people/:uuid

Parameters

Name Description
uuid Required uuid

Request

Route

GET https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31

Response

Status

200

Body

{
  "data": {
    "type": "people",
    "id": "dba33949-18d3-4f7d-83ee-8de8c1370b31",
    "attributes": {
      "created_at": "2016-01-02T03:04:05Z",
      "email": "api+einstein@schoolkeep.com",
      "first_name": "Albert",
      "full_name": "Albert Einstein",
      "last_name": "Einstein",
      "name": "Albert Einstein",
      "updated_at": "2016-02-03T04:05:06Z"
    },
    "links": {
      "self": "https://api.schoolkeep.com/v1/people/dba33949-18d3-4f7d-83ee-8de8c1370b31",
      "teaching": "https://app.schoolkeep.com/people/397"
    }
  }
}

Delete a person

Permanently deletes a person. It cannot be undone.

Endpoint

DELETE /v1/people/:uuid

Parameters

Name Description
uuid Required uuid

Request

Route

DELETE https://api.schoolkeep.com/v1/people/0a5318a7-72fc-488b-af0f-7b82991dabbe

Response

Status

204

Quizzes

List quizzes

Returns a list of quizzes. The quizzes are returned in sorted order, alphabetically, by full name.

Endpoint

GET /v1/quizzes

Parameters

Name Description
page Page to view
limit Quizzes per page
q Query term, filters by quiz name

Request

Route

GET https://api.schoolkeep.com/v1/quizzes

Response

Status

200

Body

{
  "links": {
    "self": "https://api.schoolkeep.com/v1/quizzes"
  },
  "data": [
    {
      "type": "quizzes",
      "id": "26a16c13-f969-406a-8f6b-9501ac9d2cff",
      "attributes": {
        "name": "Finance Quiz",
        "created_at": "2016-01-02T03:04:05Z"
      },
      "relationships": {
        "activities": {
          "data": [

          ]
        }
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/quizzes/26a16c13-f969-406a-8f6b-9501ac9d2cff",
        "build": "https://app.schoolkeep.com/quizzes/724/builder"
      }
    },
    {
      "type": "quizzes",
      "id": "00d052d8-0659-4460-9c48-42df58f48040",
      "attributes": {
        "name": "Science Quiz",
        "created_at": "2016-01-02T03:04:05Z"
      },
      "relationships": {
        "activities": {
          "data": [

          ]
        }
      },
      "links": {
        "self": "https://api.schoolkeep.com/v1/quizzes/00d052d8-0659-4460-9c48-42df58f48040",
        "build": "https://app.schoolkeep.com/quizzes/728/builder"
      }
    }
  ],
  "included": [

  ]
}