canonical: https://jentic.com/apis/edusign.com/edusign

# Edusign API

Jentic publishes the only available OpenAPI specification for Edusign API, keeping it validated and agent-ready. Edusign is a digital attendance and signature platform for training organisations, vocational schools, and higher-education programmes. The v1 API exposes 13 endpoints to manage students, professors, courses, training programmes, surveys, groups, and per-school configuration so administrators can wire Edusign into their internal systems and automations.

## For AI agents

Manage students, professors, courses, groups, and training programmes inside an Edusign training organisation account.

## Scope

Does not handle attendance capture, e-signature collection, billing, or grade reporting - use for managing students, professors, courses, training programmes, groups, surveys, and school configuration only.

## Capabilities

- List, create, read, and update students inside an Edusign account
- Create professor records that can later be associated with courses
- Query and create courses, and lock a course to prevent further changes
- Create training programmes that bundle a sequence of courses for a cohort
- Create groups so students can be enrolled into shared cohorts
- Create surveys that capture feedback from students at the end of a course
- Configure per-school settings via PATCH on the school resource

## Use cases

### Provisioning students from an admissions system

A vocational school keeps applicant data in an admissions tool and needs each newly admitted student to land in Edusign so attendance and signatures can be tracked. An automation calls POST /student for each admitted record, retrieves the new student via GET /student/{id}, and stores the Edusign identifier back on the admissions record. The 13-endpoint surface keeps the integration tightly scoped.

Example prompt: POST /student with the applicant's name, email, and programme reference, then store the returned student ID against the admissions record.

### Course-and-cohort setup for a training provider

A training provider opening a new cohort needs to set up a course, a group of students, and a feedback survey in Edusign. The API supports POST /course to create the course, POST /group for the cohort, POST /trainings for a multi-course programme, and POST /surveys for the post-course feedback form. Locking the course later via POST /course/lock/{courseId} freezes the schedule once enrolment closes.

Example prompt: Create the course with POST /course, create the cohort group with POST /group, create the training programme with POST /trainings, and finish with POST /surveys to register the feedback survey.

### Compliance-driven attendance tooling

Vocational training providers in regulated markets need verifiable attendance records. An internal tool fetches Edusign student and course data, ties them to attendance reports gathered elsewhere, and updates Edusign whenever a record changes. Locking the course at the end of the programme via the lock endpoint protects the attendance ledger from edits.

Example prompt: GET /course/{id} to fetch the active course, then POST /course/lock/{courseId} once the programme finishes to freeze the attendance record.

### Edusign as an agent tool through Jentic

A school operations agent provisions students, creates cohorts, and launches feedback surveys on demand. Through Jentic, the agent searches by intent, receives the matching Edusign operation, and executes it with the bearer token Jentic injects at runtime. The agent does not need to read 13 endpoint specs by hand.

Example prompt: Search Jentic for 'create a student in Edusign', load the schema, and execute POST /student with the data captured in the agent's intake form.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /student | Create a student |
| GET | /student | List students |
| PUT | /student/{id} | Update a student |
| POST | /course | Create a course |
| POST | /course/lock/{courseId} | Lock a course |
| POST | /trainings | Create a training programme |
| POST | /surveys | Create a survey |
| POST | /group | Create a group |

## Key resources

- **Students** — List, create, read, and update student records
- **Professors** — Create professor records
- **Courses** — Query, create, retrieve, and lock courses
- **Trainings** — Create training programmes that bundle courses
- **Surveys** — Create student feedback surveys
- **Groups** — Create cohort groups for students
- **School** — Patch per-school configuration

## Why Jentic

- **Setup:** Wiring Edusign by hand means handling its bearer auth, choosing between the v1 and v2 hosts, and setting the Authorization header on every call yourself. Through Jentic you install once, import the Edusign API from the API Directory, store the bearer token once, and your agent calls it.
- **Permission scoping:** Edusign puts the resource id in the URL path (/student/{id}, /course/lock/{courseId}), so a rule can pin your agent to one student or course. You choose the operations it may call, so create operations like POST /student or POST /trainings are not included unless you add them.
- **Credential handling:** Your Edusign bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a student in Edusign' or 'lock an Edusign course', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Schoology API** — Schoology is a broader learning platform with a richer course, assignment, and gradebook surface.
- **Calendly API** — Calendly schedules tutor or admissions calls alongside Edusign student management.
- **Brevo API** — Brevo sends welcome emails and survey reminders for cohorts created in Edusign.

## FAQ

### Why is there no official OpenAPI spec for Edusign API?

Edusign does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Edusign API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Edusign API use?

Edusign uses HTTP bearer authentication. Pass the API token in the Authorization: Bearer header on every call. Jentic stores the token encrypted in its vault and injects it at execution time so the agent never sees the raw secret.

### Can I create and update students with the Edusign API?

Yes. POST /student creates a student, PUT /student/{id} updates one, GET /student/{id} retrieves a single record, and GET /student lists them. Use these to keep Edusign in sync with an admissions system.

### How do I lock a course so the schedule cannot change?

Call POST /course/lock/{courseId} after the course has finished or once enrolment has closed. The lock endpoint prevents further edits to that course in Edusign.

### What are the rate limits for the Edusign API?

Rate limits are not declared in the OpenAPI spec. For school provisioning workloads the call volume is usually low, but build retries with exponential backoff and avoid tight polling on the list endpoints.

### How do I create a student through Jentic?

Run pip install jentic, search Jentic for 'create a student in Edusign', load the POST /student schema, and execute the call with the student's name, email, and programme reference. Jentic handles the bearer-token injection and returns the new student ID.

### Does the Edusign API expose attendance records or signature data?

Not in this published v1 spec. The 13 endpoints cover student, professor, course, training, group, survey, and school operations. Attendance and signature data continue to be managed inside the Edusign product UI.

### Can I limit what my agent is allowed to do with the Edusign API?

Yes. Because you run Jentic One yourself, your own rules decide which Edusign operations the agent may call and which bearer token it uses. You can grant read-only access with GET /student and GET /course/{id} while withholding write operations such as POST /student, POST /trainings, or POST /course/lock/{courseId}. Since Edusign carries the resource id in the URL path, like /student/{id} and /course/lock/{courseId}, you can also pin the agent to a single student or course.
