> 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/overview.md).

# Overview

Which Medtrics API to use, and where to start.

Connect your SIS, scheduling tool, LMS or data warehouse to Medtrics. Every tenant is served from its own host, `https://<client-name>.mymedtrics.com`; four client-facing API layers share that origin.

### Choose a layer

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Connect API</strong></td><td>The long-term public contract. A trusted outside system reads and partially writes one tenant's institution data under scoped, expiring, display-once credentials. For client IT teams, SIS vendors (Banner, PeopleSoft), scheduling tools, data warehouses.</td><td><a href="/api-reference/connect-api.md">Connect API</a></td><td><a href="https://2912658775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxpbJErq8GWWHPPkzmpv3%2Fuploads%2F06H71Uh9NrKLrnd4RQPb%2Fcover-connect.png?alt=media">cover-connect.png</a></td></tr><tr><td><strong>GraphQL gateway</strong></td><td>Customer-facing control plane for the integrations hub. Not domain data; the registry of integrations, API keys, audit log, health and LTI platforms. For partner integrators and institution admins automating integration setup.</td><td><a href="/api-reference/graphql-gateway.md">GraphQL gateway</a></td><td><a href="https://2912658775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxpbJErq8GWWHPPkzmpv3%2Fuploads%2FChIP7anOJhG4xsmP8KWr%2Fcover-graphql.png?alt=media">cover-graphql.png</a></td></tr><tr><td><strong>LTI 1.3</strong></td><td>Lets an LMS launch Medtrics as a tool and receive grades back. For LMS administrators at the institution (Canvas, Moodle, Blackboard).</td><td><a href="/api-reference/lti-1.3.md">LTI 1.3</a></td><td><a href="https://2912658775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxpbJErq8GWWHPPkzmpv3%2Fuploads%2F0VU7eoL3Qh4EKGJ4OdC2%2Fcover-lti.png?alt=media">cover-lti.png</a></td></tr><tr><td><strong>Medtrics Classic SIS Bridge</strong></td><td>Keeps an SIS integration written against Medtrics Classic running after the client moves to Oracle, with a bounded set of changes instead of a rewrite. For institutions moving from Medtrics Classic to Oracle whose SIS or scripts already call /api-banner/ and /api/; Medtrics operates the bridge for them during the migration.</td><td><a href="/api-reference/medtrics-classic-sis-bridge.md">Medtrics Classic SIS Bridge</a></td><td><a href="https://2912658775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxpbJErq8GWWHPPkzmpv3%2Fuploads%2FMoEGfwrYJGO0rJL1CldF%2Fcover-bridge.png?alt=media">cover-bridge.png</a></td></tr></tbody></table>

### Start here

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Administrator workflows</strong></td><td>What an administrator does with the API, job by job, with the scopes each job needs.</td><td><a href="/get-started/admin-workflows.md">Admin workflows</a></td><td><a href="https://2912658775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxpbJErq8GWWHPPkzmpv3%2Fuploads%2FfmOqXZBVdZqmz5MPx23A%2Fcover-workflows.png?alt=media">cover-workflows.png</a></td></tr><tr><td><strong>Conventions</strong></td><td>Authentication, idempotency, webhook delivery and signing, rate limits, hosting.</td><td><a href="/get-started/conventions.md">Conventions</a></td><td><a href="https://2912658775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxpbJErq8GWWHPPkzmpv3%2Fuploads%2FljzCPPPIk55KdU3YyCzj%2Fcover-conventions.png?alt=media">cover-conventions.png</a></td></tr><tr><td><strong>Postman</strong></td><td>A ready-made collection and sandbox environment; the first request fetches a token.</td><td><a href="/get-started/postman.md">Postman</a></td><td><a href="https://2912658775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxpbJErq8GWWHPPkzmpv3%2Fuploads%2F7THvxFGO8x4V0bRbG9pp%2Fcover-postman.png?alt=media">cover-postman.png</a></td></tr><tr><td><strong>Classic data mapping</strong></td><td>Where each Medtrics Classic table and field lands in Oracle — confirmed mappings only, from the migration loaders.</td><td><a href="/get-started/classic-data-mapping.md">Classic data mapping</a></td><td><a href="https://2912658775-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxpbJErq8GWWHPPkzmpv3%2Fuploads%2FkDUDwYmznHw0N5M58fbm%2Fcover-mapping.png?alt=media">cover-mapping.png</a></td></tr></tbody></table>

| Layer                                                | Base URL                                                   | Who integrates                                                                                                                                                            |
| ---------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Connect API](/api-reference/connect-api.md)         | `https://<client-name>.mymedtrics.com/connect`             | Client IT teams, SIS vendors (Banner, PeopleSoft), scheduling tools, data warehouses.                                                                                     |
| Medtrics Classic SIS Bridge (Compatibility API)      | `https://<client-name>.mymedtrics.com/api-banner and /api` | Institutions moving from Medtrics Classic to Oracle whose SIS or scripts already call /api-banner/ and /api/; Medtrics operates the bridge for them during the migration. |
| [GraphQL gateway](/api-reference/graphql-gateway.md) | `https://<client-name>.mymedtrics.com/graphql/v1`          | Partner integrators and institution admins automating integration setup.                                                                                                  |
| [LTI 1.3](/api-reference/lti-1.3.md)                 | `https://<client-name>.mymedtrics.com/lti`                 | LMS administrators at the institution (Canvas, Moodle, Blackboard).                                                                                                       |

Support: <help@medtrics.com> · Community: [neo.medtricslab.com](https://neo.medtricslab.com/).


---

# 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/overview.md?ask=<question>&goal=<user_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.