Student Portfolio

Get a student portfolio

get

Retrieve a student portfolio by its UUID

Path parameters

uuidstring · uuidRequired

Student Portfolio UUID

Responses

200

Student portfolio retrieved successfully

application/json

404

No student portfolio found.

get

HTTPcURLJavaScriptPython

GET /v1/student-portfolios/{uuid} HTTP/1.1
Host: 
Accept: */*

{
  "teacherPortfolio": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "title": "text",
    "description": "text",
    "coverImageUrl": "text",
    "courseIds": [
      1
    ],
    "skills": [
      {
        "name": "text",
        "status": "not_completed",
        "mentionCount": 1
      }
    ],
    "sections": {
      "defaultSection": {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "title": "text",
        "requirements": [
          {
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "title": "text",
            "description": "text",
            "reflectionQuestions": [
              "text"
            ],
            "order": 1,
            "createdAt": "2025-10-13T20:19:24.442Z",
            "updatedAt": "2025-10-13T20:19:24.442Z",
            "skills": [
              {
                "name": "text",
                "status": "not_completed",
                "mentionCount": 1
              }
            ],
            "type": "project",
            "canvasAssignmentId": 1,
            "courseId": 1,
            "courseName": "text",
            "gradingType": "text",
            "htmlUrl": "text",
            "pointsPossible": 1,
            "submissionTypes": [
              "text"
            ]
          }
        ],
        "order": 1
      },
      "userSections": [
        {
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "title": "text",
          "requirements": [
            {
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "userId": "123e4567-e89b-12d3-a456-426614174000",
              "title": "text",
              "description": "text",
              "reflectionQuestions": [
                "text"
              ],
              "order": 1,
              "createdAt": "2025-10-13T20:19:24.442Z",
              "updatedAt": "2025-10-13T20:19:24.442Z",
              "skills": [
                {
                  "name": "text",
                  "status": "not_completed",
                  "mentionCount": 1
                }
              ],
              "type": "project",
              "canvasAssignmentId": 1,
              "courseId": 1,
              "courseName": "text",
              "gradingType": "text",
              "htmlUrl": "text",
              "pointsPossible": 1,
              "submissionTypes": [
                "text"
              ]
            }
          ],
          "order": 1
        }
      ]
    },
    "teacherPortfolioState": "draft"
  },
  "studentPortfolio": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "canvasStudentId": 1,
    "status": "not_started",
    "evidences": [
      {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "requirementId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "not_submitted",
        "description": "text",
        "reflection": "text",
        "links": [
          "text"
        ],
        "attachments": [
          {
            "url": "text",
            "mimeType": "text",
            "fileSize": 1,
            "fileName": "text"
          }
        ],
        "teammateCanvasIds": [
          1
        ],
        "commentCount": 1,
        "skillCount": 1
      }
    ],
    "assignmentSubmissions": [
      {
        "assignmentId": 1,
        "assignmentName": "text",
        "assignmentDescription": "text",
        "courseId": 1,
        "courseName": "text",
        "htmlUrl": "text",
        "submissionType": "text",
        "submissionLink": "text",
        "body": "text",
        "pointsPossible": 1,
        "gradingType": "text",
        "score": 1,
        "commentCount": 1,
        "status": "unsubmitted",
        "createdAt": "2025-10-13T20:19:24.442Z"
      }
    ],
    "createdAt": "2025-10-13T20:19:24.442Z",
    "updatedAt": "2025-10-13T20:19:24.442Z"
  }
}

Get teammates

get

Get teammates for a student portfolio

Path parameters

portfolioIdstringRequired

Query parameters

pagenumber · min: 1Optional

Page number (must be greater than 0)

Default: 1

pageSizenumber · min: 1 · max: 100Optional

Number of items per page (must be between 1 and 100)

Default: 20

sortBystringOptional

Field to sort by

sortOrderstring · enumOptional

Sort order

Possible values:

searchstringOptional

Search query

Responses

200

Students retrieved successfully

application/json

get

HTTPcURLJavaScriptPython

GET /v1/student-portfolios/{portfolioId}/teammates HTTP/1.1
Host: 
Accept: */*

200

Students retrieved successfully

{
  "data": [
    {
      "canvasUserId": 1,
      "name": "text",
      "sortableName": "text",
      "email": "text",
      "avatarUrl": "text"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "lastPage": 1,
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}