> For the complete documentation index, see [llms.txt](https://docs.mymedtrics.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mymedtrics.com/get-started/admin-workflows.md). # Admin workflows What an administrator does with the API, job by job, with the scopes each job needs. What a program or platform administrator does to keep a program running, and how much of each job the Connect API carries today. Every operation is checked against the contract and every scope is read from the gateway's `routes.ts`. | Item | Value | | ----------------------------------- | ------------- | | Workflows | 23 in 9 areas | | Supported end to end | 16 | | Partial — the rest stays in the app | 4 | | Not exposed by the API | 3 | | With an Arazzo walkthrough | 11 of 23 | ### How to read this page * **Operations** link to the operation in the Connect reference, where a request sample can be copied. * **Scopes** are the scopes an API app must hold to run the whole workflow; grant exactly these when creating the app. * **Status**: *supported* means every step exists in the contract; *partial* means part of the job is done in the app; *not exposed* means the API cannot do it yet. ### Integration setup and lifecycle Connect an SIS, scheduling tool or warehouse and keep the connection healthy. | Workflow | When | Operations | Scopes | Status | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | --------- | |

Create an API app and hand off its credential
App creation, scope selection, credential reveal, rotation and revocation happen in the portal, not through the API. The API starts at the token exchange.

POST /oauth/token
GET /programs
GET /learners
GET /programs/{programId}

POST /webhooks
POST /webhooks/{webhookId}/test
GET /webhooks
GET /webhooks/{webhookId}

| `webhooks:read` `webhooks:write` | supported | |

Poll a bulk import job to completion
Jobs can be polled and the import\_job.completed event fires, but POST /import-jobs is deferred (returns 405). Bulk imports are started in the app's import wizard today.

| After every bulk import | [`GET /import-jobs/{jobId}`](https://medtricslab.gitbook.io/medtricslab-docs/api-reference/connect-api/imports#getimportjob) | `imports:read` | partial | ### Program structure and reference data Know the programs, roles, sites, periods and catalogs the integration must map to. | Workflow | When | Operations | Scopes | Status | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | | **Read the program directory** | Daily or on program.updated |

GET /programs
GET /programs/{programId}

| `programs:read` | supported | | **Pull reference data per program (roles, sites, periods, rotation definitions, score and exam types, case templates)** | Before any write; refresh termly |

GET /roles
GET /roles/{roleId}
GET /sites
GET /sites/{siteId}
GET /academic-periods
GET /academic-periods/{academicPeriodId}
GET /rotation-definitions
GET /rotation-definitions/{rotationDefinitionId}
GET /score-types
GET /exam-types
GET /case-templates
GET /group-leader-roles
GET /group-tags

| `academic-periods:read` `case-templates:read` `exam-scores:read` `groups:read` `roles:read` `rotation-definitions:read` `scores:read` `sites:read` | supported | |

Maintain the rotation and course catalogs (rotation definitions, rotation sites, curriculum courses, graded course rotations)
Create only; no update or delete for these four catalogs, so corrections are made in the app.

| Termly, when the curriculum changes |

POST /rotation-definitions
POST /rotation-sites
POST /curriculum-courses
POST /graded-course-rotations

| `curriculum-courses:write` `graded-course-rotations:write` `rotation-definitions:write` `rotations:write` | partial | |

Create or rename a program, site or academic period
Programs, sites and academic periods are read-only in the API.

| Yearly, at setup | in app: `/programs` `/sites` | — | not exposed | ### Academic calendar Set up the year's blocks before schedules can be built. | Workflow | When | Operations | Scopes | Status | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | --------- | |

Create, adjust and remove the year's blocks
Arazzo covers only the lookup; the create/adjust/remove path has no written workflow yet.

| Yearly rollover, then ad hoc corrections |

GET /academic-periods
GET /blocks
POST /blocks
PATCH /blocks/{blockId}
DELETE /blocks/{blockId}
GET /blocks/{blockId}

| `academic-periods:read` `blocks:delete` `blocks:read` `blocks:write` | supported | ### People and enrollment Keep the roster true to the SIS — intake, changes, promotion, offboarding. | Workflow | When | Operations | Scopes | Status | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- | --------- | |

Nightly roster sync from the SIS (upsert learners and enrollments)
Arazzo covers the read side; the write side (match by external id, then create or patch) has no written workflow yet. putLearner exists for full replacement.

| Nightly |

GET /learners
GET /learners/{learnerId}
POST /learners
PATCH /learners/{learnerId}
GET /learners/{learnerId}/enrollments
POST /enrollments
PATCH /enrollments/{enrollmentId}

GET /learners/{learnerId}/enrollments
GET /enrollments/{enrollmentId}
GET /programs/{programId}/enrollments

| `learners:read` | supported | |

Offboard a learner or end an enrollment
Deactivate, not delete. Transfers (end one enrollment, create another) are two calls; the app does it atomically.

| Graduation, withdrawal, transfer |

POST /enrollments/{enrollmentId}/deactivate
POST /learners/{learnerId}/deactivate

| `enrollments:write` `learners:write` | supported | |

Schedule the July-1 PGY advancement
Create and read only; no update or cancel of a scheduled advancement through the API.

| Yearly |

GET /advancements
POST /advancements
GET /advancements/{advancementId}

| `advancements:read` `advancements:write` | partial | ### Rotation and clinical scheduling Publish who is where and when, and keep it in step with the scheduling system. | Workflow | When | Operations | Scopes | Status | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | --------- | | **Sync rotation assignments (block schedules) with date filters** | Nightly or on rotation.assignment\_changed |

GET /rotations
GET /rotations/{rotationId}

| `rotations:read` | supported | |

Push rotation assignments from an external scheduler
Write path exists; no written workflow and no bulk endpoint (import resource type "rotations" is defined but createImportJob is deferred).

| On publish in the scheduling system |

GET /blocks
GET /rotation-definitions
POST /rotations
PATCH /rotations/{rotationId}
DELETE /rotations/{rotationId}

| `blocks:read` `rotation-definitions:read` `rotations:delete` `rotations:write` | supported | |

Create a clinical schedule and grant users and admins access
Arazzo covers the sync read; the create-and-grant path has no written workflow.

| Termly |

GET /clinical-schedules
POST /clinical-schedules
PATCH /clinical-schedules/{clinicalScheduleId}
POST /clinical-schedules/{clinicalScheduleId}/users
POST /clinical-schedules/{clinicalScheduleId}/admins
DELETE /clinical-schedules/{clinicalScheduleId}

| `clinical-schedules:delete` `clinical-schedules:read` `clinical-schedules:write` | supported | ### Groups, tags and leader roles Maintain cohorts, committees and their leaders. | Workflow | When | Operations | Scopes | Status | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | --------- | |

Create groups, add and remove members, tag them, assign leader roles
Fullest write surface in the API (full CRUD) but no Arazzo workflow at all.

| Termly and ad hoc |

GET /groups
POST /groups
PATCH /groups/{groupId}
DELETE /groups/{groupId}
GET /group-members
POST /group-members
DELETE /group-members/{groupMemberId}
POST /group-tags
POST /group-leader-roles

| `groups:delete` `groups:read` `groups:write` | supported | ### Assessment and scores Load exam results and gradebook scores from testing vendors and LMSs. | Workflow | When | Operations | Scopes | Status | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | --------- | |

Post exam results (USMLE, COMLEX, in-training) from a vendor feed
Upsert semantics; PHI/FERPA — the client view must say so.

| Per exam cycle |

GET /exam-types
GET /learners
POST /exam-scores
GET /exam-scores

| `exam-scores:read` `exam-scores:write` `learners:read` | supported | |

Post gradebook scores for graded course rotations
Create only; no correction path (no patch or delete on scores).

| Per course |

GET /score-types
GET /graded-course-rotations
POST /scores
GET /scores

| `graded-course-rotations:read` `scores:read` `scores:write` | supported | ### Evaluations Reconcile evaluation completion with an external system or LMS. | Workflow | When | Operations | Scopes | Status | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----------- | | **Pull the evaluations backlog, including virtual "missing" assignments** | Weekly or on evaluation.completed |

GET /evaluations
GET /evaluations/{evaluationId}

| `evaluations:read` | supported | |

Assign evaluations from an external system
Evaluations are read-only; the import resource type "evaluations" exists but createImportJob is deferred.

| Per rotation | in app: `/forms` | — | not exposed | ### Case and procedure logs Report procedure volumes to accreditation or a data warehouse. | Workflow | When | Operations | Scopes | Status | | --------------------------------------------------------------------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ----------- | | **Export case logs against the case template catalog** | Monthly |

GET /case-templates
GET /case-logs
GET /case-logs/{caseLogId}

| `case-logs:read` `case-templates:read` | supported | |

Import case logs from a procedure-logging device
Case logs are read-only in the API.

| Daily | in app: `/import` | — | not exposed | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.mymedtrics.com/get-started/admin-workflows.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.