Get AssignmentFolder

GET

/assignment-folders/{object_id}

Assignments

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (AssignmentFolder)

required

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

AssignmentFolder

Example:

AssignmentFolder

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "AssignmentFolder",
        "attributes": {
            "name": "string"
        },
        "relationships": {
            "assignment": {
                "data": {
                    "id": "FID001",
                    "type": "Assignment"
                }
            },
            "items": {
                "data": [
                    {
                        "id": "FID001",
                        "type": "AssignmentItemAudio"
                    }
                ]
            },
            "coverImage": {
                "data": {
                    "id": "FID001",
                    "type": "File"
                }
            }
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error

Modified at 2025-07-08 10:51:21

List AvailableAccessPolicies

Create AssignmentGroupCourseVersion