Load Assignments Endpoint

The GET /assignments endpoint retrieves the list of all assignments that you have created on AssignmentOS.

Request

curl -X GET https://app.assignment-os.com/api/assignments -H 'Authorization: apiKey 5a355e5a-8e1b-4dab-a17c-4ab49fc267c3' 

Response

For successful requests, the response code will be 200 OK and the response object will be a JSON list containing one more AssignmentDetail objects. An AssignmentDetail object contains the following fields:

Field Name	JSON Data Type	Description
id	string	The Unique ID of the assignment.
name	string	The name of the assignment.
course_id	string	The Unique ID of the course this assignment belongs to in AssignmentOS.
course_name	string	The name of the course this assignment belongs to in AssignmentOS.

Example

Let's assume you have one Course on AssignmentOS called Java Intro, and that Course contains the following assignments:

Then the response from calling this endpoint will be:

[
    {
        "id": "6vb0aa8d-0d2a-4e0d-8a63-a738ab62fa0b",
        "name": "Java Week 1 - Data Structures",
        "course_id": "7b491b0a-d1c7-4cad-b66c-566715de8cc3",
        "course_name": "Java Intro"
    },
    {
        "id": "2d39c9b2-e89a-48fa-b5e3-79304c5dea06",
        "name": "Java Week 2 - Classes",
        "course_id": "7b491b0a-d1c7-4cad-b66c-566715de8cc3",
        "course_name": "Java Intro"
    },
    {
        "id": "745be3c2-ac1d-4150-9d99-062e93376cfc",
        "name": "Java Week 3 - Loops",
        "course_id": "7b491b0a-d1c7-4cad-b66c-566715de8cc3",
        "course_name": "Java Intro"
    }
]