Sharing

Create a public shareable link for a resource.

post

Authorizations

bearer

Body

application/json

visibilitystring · enumRequired

The visibility setting for the shareable link.

Example: VISIBLE_WITH_LINKPossible values:

showcasePortfolioUuidstring · uuidOptional

The unique identifier (UUID) of the Showcase Portfolio to be shared.

Example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

studentPortfolioUuidstring · uuidOptional

The unique identifier (UUID) of the Student Portfolio to be shared.

Example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

showcaseEvidenceUuidstring · uuidOptional

The unique identifier (UUID) of the Showcase Evidence to be shared.

Example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

studentEvidenceUuidstring · uuidOptional

The unique identifier (UUID) of the Student Evidence to be shared.

Example: a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11

typestring · enumRequired

The type setting for the shareable resource.

Possible values:

Responses

201

Successfully created or retrieved the shareable link.

application/json

403

Forbidden.

404

Resource not found.

post

HTTPcURLJavaScriptPython

POST /v1/share-links HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 310

{
  "visibility": "VISIBLE_WITH_LINK",
  "showcasePortfolioUuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "studentPortfolioUuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "showcaseEvidenceUuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "studentEvidenceUuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "type": "SHOWCASE_PORTFOLIO"
}

{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": "VISIBLE_WITH_LINK",
  "shareLink": "text",
  "showcasePortfolioUuid": "text",
  "studentPortfolioUuid": "text",
  "showcaseEvidenceUuid": "text",
  "studentEvidenceUuid": "text"
}

Retrieve an existing shareable link for a resource.

get

Authorizations

bearer

Query parameters

resourceIdstring · uuidRequired

The unique identifier (UUID) of the resource.

resourceTypestring · enumRequired

The type of the resource.

Possible values:

Responses

200Success

application/json

404

No share link found for the specified resource.

get

HTTPcURLJavaScriptPython

GET /v1/share-links?resourceId=123e4567-e89b-12d3-a456-426614174000&resourceType=SHOWCASE_PORTFOLIO HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "visibility": "VISIBLE_WITH_LINK",
  "shareLink": "text",
  "showcasePortfolioUuid": "text",
  "studentPortfolioUuid": "text",
  "showcaseEvidenceUuid": "text",
  "studentEvidenceUuid": "text"
}

Delete all existing shareable links for a specific resource.

delete

Authorizations

bearer

Query parameters

resourceIdstring · uuidRequired

The unique identifier (UUID) of the resource.

resourceTypestring · enumRequired

The type of the resource.

Possible values:

Responses

200

All shared links for the specified resource have been successfully deleted.

No content

404

No shared links found for the specified resource, or resource does not exist.

delete

HTTPcURLJavaScriptPython

DELETE /v1/share-links?resourceId=123e4567-e89b-12d3-a456-426614174000&resourceType=SHOWCASE_PORTFOLIO HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Retrieve a shared resource (e.g., Student Portfolio) by its link token.

get

Allows external users to view a read-only version of a shared resource without authentication.

Path parameters

linkTokenstringRequired

The unique token of the shareable link.

Example: a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Responses

200

Successfully retrieved the shared resource.

application/json

400

This link is malformed or points to an unsupported resource type.

404

This link is invalid or the content is no longer available.

get

HTTPcURLJavaScriptPython

GET /v1/share-links/{linkToken}/shared-resource HTTP/1.1
Host: 
Accept: */*

{
  "showcasePortfolio": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "title": "text",
    "authorName": "text",
    "description": "text",
    "coverImageUrl": "text",
    "status": "DRAFT",
    "sections": {
      "defaultSection": {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "title": "text",
        "order": 1,
        "evidences": [
          {
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "userId": "123e4567-e89b-12d3-a456-426614174000",
            "title": "text",
            "description": "text",
            "order": 1,
            "reflection": "text",
            "links": [
              "text"
            ],
            "attachments": [
              {
                "url": "text",
                "mimeType": "text",
                "fileSize": 1,
                "fileName": "text"
              }
            ],
            "tags": [
              "text"
            ],
            "createdAt": "2025-10-13T20:25:10.654Z",
            "updatedAt": "2025-10-13T20:25:10.654Z",
            "type": "project",
            "canvasAssignmentId": 1,
            "courseId": 1,
            "courseName": "text",
            "gradingType": "text",
            "htmlUrl": "text",
            "pointsPossible": 1,
            "submissionTypes": [
              "text"
            ],
            "assignmentSubmissionBody": "text"
          }
        ]
      },
      "userSections": [
        {
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "title": "text",
          "order": 1,
          "evidences": [
            {
              "uuid": "123e4567-e89b-12d3-a456-426614174000",
              "userId": "123e4567-e89b-12d3-a456-426614174000",
              "title": "text",
              "description": "text",
              "order": 1,
              "reflection": "text",
              "links": [
                "text"
              ],
              "attachments": [
                {
                  "url": "text",
                  "mimeType": "text",
                  "fileSize": 1,
                  "fileName": "text"
                }
              ],
              "tags": [
                "text"
              ],
              "createdAt": "2025-10-13T20:25:10.654Z",
              "updatedAt": "2025-10-13T20:25:10.654Z",
              "type": "project",
              "canvasAssignmentId": 1,
              "courseId": 1,
              "courseName": "text",
              "gradingType": "text",
              "htmlUrl": "text",
              "pointsPossible": 1,
              "submissionTypes": [
                "text"
              ],
              "assignmentSubmissionBody": "text"
            }
          ]
        }
      ]
    },
    "tags": [
      "text"
    ],
    "assignmentSubmissionsCount": 1,
    "createdAt": "2025-10-13T20:25:10.654Z",
    "updatedAt": "2025-10-13T20:25:10.654Z"
  },
  "showcaseEvidence": {
    "uuid": "text",
    "title": "text",
    "description": "text",
    "reflection": "text",
    "links": [
      "text"
    ],
    "attachments": [
      {
        "url": "text",
        "mimeType": "text",
        "fileSize": 1,
        "fileName": "text"
      }
    ],
    "tags": [
      "text"
    ],
    "type": "project",
    "createdAt": "2025-10-13T20:25:10.654Z",
    "updatedAt": "2025-10-13T20:25:10.654Z",
    "showcasePortfolioTitle": "text"
  },
  "studentPortfolio": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "canvasStudentId": 1,
    "authorName": "text",
    "teacherPortfolioTitle": "text",
    "teacherPortfolioDescription": "text",
    "coverImageUrl": "text",
    "courseIds": [
      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:25:10.654Z",
            "updatedAt": "2025-10-13T20:25:10.654Z",
            "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:25:10.654Z",
              "updatedAt": "2025-10-13T20:25:10.654Z",
              "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
        }
      ]
    },
    "status": "not_started",
    "evidences": [
      {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "requirementId": "123e4567-e89b-12d3-a456-426614174000",
        "status": "not_submitted",
        "title": "text",
        "description": "text",
        "reflection": "text",
        "links": [
          "text"
        ],
        "attachments": [
          {
            "url": "text",
            "mimeType": "text",
            "fileSize": 1,
            "fileName": "text"
          }
        ],
        "skills": [
          {
            "name": "text",
            "status": "not_completed",
            "mentionCount": 1
          }
        ],
        "type": "project",
        "createdAt": "2025-10-13T20:25:10.654Z",
        "updatedAt": "2025-10-13T20:25:10.654Z",
        "teacherPortfolioTitle": "text"
      }
    ],
    "assignmentSubmissions": 1,
    "createdAt": "2025-10-13T20:25:10.654Z",
    "updatedAt": "2025-10-13T20:25:10.654Z",
    "skills": [
      {
        "name": "text",
        "status": "not_completed",
        "mentionCount": 1
      }
    ]
  },
  "studentPortfolioEvidence": {
    "uuid": "123e4567-e89b-12d3-a456-426614174000",
    "requirementId": "123e4567-e89b-12d3-a456-426614174000",
    "status": "not_submitted",
    "title": "text",
    "description": "text",
    "reflection": "text",
    "links": [
      "text"
    ],
    "attachments": [
      {
        "url": "text",
        "mimeType": "text",
        "fileSize": 1,
        "fileName": "text"
      }
    ],
    "skills": [
      {
        "name": "text",
        "status": "not_completed",
        "mentionCount": 1
      }
    ],
    "type": "project",
    "createdAt": "2025-10-13T20:25:10.654Z",
    "updatedAt": "2025-10-13T20:25:10.654Z",
    "teacherPortfolioTitle": "text"
  },
  "type": "SHOWCASE_PORTFOLIO"
}