Canvas

Canvas Temporary Enrollment Pairings API

The Temporary Enrollment Pairings API from Canvas — 3 operation(s) for temporary enrollment pairings.

GitHub OpenAPI

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/accounts/{account_id}/temporary_enrollment_pairings List temporary enrollment pairings · List temporary enrollment pairings #
Ask an LLM
“Which temporary enrollment pairings exist in our root account?”
“Can I include pairings that have been deleted?”
Tell an agent
List temporary enrollment pairings in account {account_id}.
Show account {account_id} pairings including deleted ones: {include_deleted}.
POST /v1/accounts/{account_id}/temporary_enrollment_pairings Create a temporary enrollment pairing · Create Temporary Enrollment Pairing #
Ask an LLM
“How do I set up a temporary enrollment pairing, for example for a substitute teacher?”
“Can I choose what state the enrollments end in when a pairing expires?”
Tell an agent
Create a temporary enrollment pairing in account {account_id}.
Create a pairing in account {account_id} whose enrollments end as {ending_enrollment_state}.
GET /v1/accounts/{account_id}/temporary_enrollment_pairings/{id} Get one temporary enrollment pairing · Get a single temporary enrollment pairing #
Ask an LLM
“How do I look up a specific temporary enrollment pairing?”
“What state is a given temporary pairing in?”
Tell an agent
Show temporary enrollment pairing {id} in account {account_id}.
Get the details of pairing {id} in account {account_id}.
DELETE /v1/accounts/{account_id}/temporary_enrollment_pairings/{id} Delete a temporary enrollment pairing · Delete Temporary Enrollment Pairing #
Ask an LLM
“Can I remove a temporary enrollment pairing once it's no longer needed?”
“Will a deleted pairing still show up if I ask for deleted ones?”
Tell an agent destructive · confirm first
Delete temporary enrollment pairing {id} in account {account_id}.
Remove pairing {id} from account {account_id}.
GET /v1/accounts/{account_id}/temporary_enrollment_pairings/new Start a blank temporary enrollment pairing · New TemporaryEnrollmentPairing #
Ask an LLM
“Can I get an unsaved template of a temporary enrollment pairing before creating one?”
“What defaults does a new temporary pairing start with?”
Tell an agent
Initialize an unsaved temporary enrollment pairing for account {account_id}.
Give me a blank pairing template for account {account_id}.

Documentation

📖
Documentation
https://canvas.instructure.com/doc/api/
📖
Authentication
https://canvas.instructure.com/doc/api/file.oauth.html
📖
APIReference
https://canvas.instructure.com/doc/api/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/rate-limits/canvas-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/openapi/canvas-temporary-enrollment-pairings-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/instructure/canvas-lms

Other Resources

🔗
Pagination
https://canvas.instructure.com/doc/api/file.pagination.html
🔗
Swagger
https://canvas.instructure.com/doc/api/api-docs.json
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/scopes/canvas-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/errors/canvas-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/data-model/canvas-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/canvas:canvas-temporary-enrollment-pairings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

canvas-temporary-enrollment-pairings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Canvas LMS REST Temporary Enrollment Pairings API
  version: v1
  summary: The complete Canvas LMS REST API, converted from the Swagger 1.2 documents Instructure publishes under https://canvas.instructure.com/doc/api/.
  description: The Canvas LMS REST API covers courses, assignments, quizzes, grades, users, enrollments, accounts, files, modules, rubrics, submissions, SIS imports, LTI, analytics and account administration.
  contact:
    name: Instructure Canvas
    url: https://canvas.instructure.com/doc/api/
  license:
    name: AGPL-3.0
    url: https://github.com/instructure/canvas-lms/blob/master/LICENSE
servers:
- url: https://canvas.instructure.com/api
  description: Instructure-hosted Canvas (canvas.instructure.com)
- url: https://{canvas_host}/api
  description: Any Canvas instance; Canvas is multi-tenant and self-hostable, so the host is the institution's Canvas domain.
  variables:
    canvas_host:
      default: canvas.instructure.com
      description: Your institution's Canvas hostname, e.g. school.instructure.com
security:
- bearerAuth: []
- oauth2: []
tags:
- name: Temporary Enrollment Pairings
  x-resource: temporary_enrollment_pairings
  externalDocs:
    url: https://canvas.instructure.com/doc/api/temporary_enrollment_pairings.html
paths:
  /v1/accounts/{account_id}/temporary_enrollment_pairings:
    get:
      tags:
      - Temporary Enrollment Pairings
      operationId: list_temporary_enrollment_pairings
      summary: List temporary enrollment pairings
      description: Returns the list of temporary enrollment pairings for a root account.
      parameters:
      - name: account_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      - name: include_deleted
        in: query
        schema:
          type: boolean
        required: false
        description: If true, include deleted pairings in the response. Defaults to false.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TemporaryEnrollmentPairing'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/temporary_enrollment_pairings.html
    post:
      tags:
      - Temporary Enrollment Pairings
      operationId: create_temporary_enrollment_pairing
      summary: Create Temporary Enrollment Pairing
      description: Create a Temporary Enrollment Pairing.
      parameters:
      - name: account_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                workflow_state:
                  type: string
                  description: The workflow state of the temporary enrollment pairing.
                ending_enrollment_state:
                  type: string
                  enum:
                  - deleted
                  - completed
                  - inactive
                  description: 'The ending enrollment state to be given to each associated enrollment

                    when the enrollment period has been reached. Defaults to "deleted" if no value is given.

                    Accepted values are "deleted", "completed", and "inactive".'
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                workflow_state:
                  type: string
                  description: The workflow state of the temporary enrollment pairing.
                ending_enrollment_state:
                  type: string
                  enum:
                  - deleted
                  - completed
                  - inactive
                  description: 'The ending enrollment state to be given to each associated enrollment

                    when the enrollment period has been reached. Defaults to "deleted" if no value is given.

                    Accepted values are "deleted", "completed", and "inactive".'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporaryEnrollmentPairing'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/temporary_enrollment_pairings.html
  /v1/accounts/{account_id}/temporary_enrollment_pairings/{id}:
    get:
      tags:
      - Temporary Enrollment Pairings
      operationId: get_single_temporary_enrollment_pairing
      summary: Get a single temporary enrollment pairing
      description: Returns the temporary enrollment pairing with the given id.
      parameters:
      - name: account_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporaryEnrollmentPairing'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/temporary_enrollment_pairings.html
    delete:
      tags:
      - Temporary Enrollment Pairings
      operationId: delete_temporary_enrollment_pairing
      summary: Delete Temporary Enrollment Pairing
      description: Delete a temporary enrollment pairing
      parameters:
      - name: account_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      - name: id
        in: path
        schema:
          type: string
        required: true
        description: ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporaryEnrollmentPairing'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/temporary_enrollment_pairings.html
  /v1/accounts/{account_id}/temporary_enrollment_pairings/new:
    get:
      tags:
      - Temporary Enrollment Pairings
      operationId: new_temporaryenrollmentpairing
      summary: New TemporaryEnrollmentPairing
      description: Initialize an unsaved Temporary Enrollment Pairing.
      parameters:
      - name: account_id
        in: path
        schema:
          type: string
        required: true
        description: ID
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemporaryEnrollmentPairing'
      externalDocs:
        url: https://canvas.instructure.com/doc/api/temporary_enrollment_pairings.html
components:
  schemas:
    TemporaryEnrollmentPairing:
      type: object
      properties:
        id:
          type: integer
          example: 1
          description: the ID of the temporary enrollment pairing
        workflow_state:
          type: string
          example: active
          description: The current status of the temporary enrollment pairing
      description: A pairing unique to that enrollment period given to a recipient of that temporary enrollment.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Canvas OAuth2 access token sent as "Authorization: Bearer <token>". See https://canvas.instructure.com/doc/api/file.oauth.html'
    oauth2:
      type: oauth2
      description: Canvas OAuth2. See https://canvas.instructure.com/doc/api/file.oauth.html and https://canvas.instructure.com/doc/api/file.oauth_endpoints.html
      flows:
        authorizationCode:
          authorizationUrl: https://canvas.instructure.com/login/oauth2/auth
          tokenUrl: https://canvas.instructure.com/login/oauth2/token
          refreshUrl: https://canvas.instructure.com/login/oauth2/token
          scopes: {}
externalDocs:
  description: Canvas LMS REST API Documentation
  url: https://canvas.instructure.com/doc/api/
x-generated-from: https://canvas.instructure.com/doc/api/api-docs.json
x-provenance:
  method: derived
  derived_by: API Evangelist enrichment pipeline (Swagger 1.2 -> OpenAPI 3.1 conversion)
  source: openapi/_original/swagger-1.2/*.json (144 verbatim first-party Swagger 1.2 documents)
  source_url: https://canvas.instructure.com/doc/api/api-docs.json
  fetched: '2026-09-05'
  http_status: 200