# Edusign Documentation

> Edusign API documentation, integrate attendance and communication features into your mobile app for higher education. Build on Edusign’s platform and simplify student engagement. Ideal for developers and IT teams in universities. AppScho by Edusign available now. MCP for AI Agents included.

## Documentation: Overview
- [🌍 Overview](https://developers.edusign.com/docs/overview.md)

## Documentation: API
- [Authentication - Use the API](https://developers.edusign.com/docs/api-reference.md): Everything about authentication and using Edusign's API.
- [Requests and responses](https://developers.edusign.com/docs/requests-and-responses.md)
- [ Date and Timezone Management in Our API](https://developers.edusign.com/docs/gestion-des-dates-et-fuseaux-horaires-dans-notre-api.md)
- [Webhooks](https://developers.edusign.com/docs/webhooks-2.md): Learn about Edusign webhooks, authentication methods, timezone handling, and how to secure your webhook endpoints with Client Secret and HMAC verification.
- [Postman Collection](https://developers.edusign.com/docs/postman-collection.md): Import the API references in Postman for ease of use
- [Course creation example](https://developers.edusign.com/docs/example-add-a-course-and-its-content-from-a-to-z.md): Learn how to set up courses in Edusign from basic student management to advanced automation features. Complete guide with API examples, best practices, and benefits.
- [API V1 & API V3 (Next)](https://developers.edusign.com/docs/api-v1-api-v3-next.md)

## Documentation: MCP Server
- [MCP: Connect Edusign to AI assistants](https://developers.edusign.com/docs/mcp.md)

## Documentation: Building an app
- [🔍 About the App Marketplace](https://developers.edusign.com/docs/about-the-app-marketplace-1.md)
- [👷 Create an app](https://developers.edusign.com/docs/building-an-app.md)
- [📓 Glossary](https://developers.edusign.com/docs/glossary.md)
  - [⚙️ Actions Documentation](https://developers.edusign.com/docs/actions-documentation.md)
    - [🏫 Admin Platform Actions](https://developers.edusign.com/docs/admin-actions-platform.md)
    - [👨‍🏫 Professor Platform Actions](https://developers.edusign.com/docs/professor-platform-actions.md)
    - [🧑‍🎓 Student Platform Actions](https://developers.edusign.com/docs/student-platform-actions.md)
  - [🔀 Webhooks Documentation](https://developers.edusign.com/docs/webhooks-documentation.md)
  - [📓 Detailed permissions](https://developers.edusign.com/docs/detailed-permissions.md)
- [💡 Publish your app](https://developers.edusign.com/docs/publishing-your-app-1.md)
  - [📓 Publishing guidelines](https://developers.edusign.com/docs/guidelines-for-publishing.md)
- [📂 Resources](https://developers.edusign.com/docs/resources.md)
  - [📓 Edusign Library](https://developers.edusign.com/docs/edusign-library.md)
  - [📓 Data sharing](https://developers.edusign.com/docs/data-sharing.md)
  - [📓 API Key Access Rights](https://developers.edusign.com/docs/api-key-access-rights.md)
  - [🔮 Use Cases](https://developers.edusign.com/docs/use-cases.md)

## Documentation: SSO (Idp)
- [🔍 Getting Started with SSO](https://developers.edusign.com/docs/getting-started-1.md): How to connect to OAuth 2.0
- [👷 Prerequisites](https://developers.edusign.com/docs/prerequisites.md): To be able to connect to Edusign from your site, you'll need to use client identifiers, i.e. a client_id and a client_secret.
- [🎢 Login](https://developers.edusign.com/docs/install.md)
- [🕵️ Retrieving user information](https://developers.edusign.com/docs/️-retrieving-user-information.md)

## Documentation: References
- [📓 REST API Reference](https://developers.edusign.com/docs/api-reference-1.md)
- [📓 Edusign Application Blocks](https://developers.edusign.com/docs/edusign-block-builder.md)
  - [📓Application Blocks Definition](https://developers.edusign.com/docs/block-types-definition.md): Definition of applications blocks for educational applications.
  - [👷 Edusign Application Blocks Tool](https://developers.edusign.com/docs/edusign-application-blocks-tool.md): @_edusign/api Application Blocks Tool Documentation

## API Reference: EDUSIGN API
- Absences
  - [Archive an absence reason](https://developers.edusign.com/reference/deleteabsencereasons.md): Archive an absence reason (soft delete).
  - [Get all absence reasons](https://developers.edusign.com/reference/getabsencereasons.md): Retrieve all the absences reasons of your school (both archived or not).
  - [Create an absence reason](https://developers.edusign.com/reference/postabsencereasons.md): Create a new absence reason. Must define an absence reason ID to create it.
  - [Delete a justified absence](https://developers.edusign.com/reference/deletev1justifiedabsenceabsenceid.md): Delete a single justified absence (hard delete).
  - [Get a justified absence by ID](https://developers.edusign.com/reference/getjustifiedabsence.md): Retrieve a single justified absence using its ID.
  - [Update a justified absence](https://developers.edusign.com/reference/patchv1justifiedabsenceabsenceid.md): Update a single student justified absence.
  - [Get all justified absences](https://developers.edusign.com/reference/getv1justifiedabsence.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the justified absences of your school. <br><strong style="color:gold">WARNING</strong> This is an heavy…
  - [Create a justified absence](https://developers.edusign.com/reference/postv1justifiedabsence.md): Create a new justified absence for a student. You can upload a base64 PDF file (max 4mb) as an attachment. <br><br> <strong>Important:</strong> The absence dates (START/END) are automatically set…
  - [Create a justified absence between two dates](https://developers.edusign.com/reference/postv1justifiedabsencemultiple.md): Create a new justified absence for a student for all the courses between two dates provided. You can upload a base64 PDF file (max 4mb) as an attachment.
- Apps
  - [Get an app parameters](https://developers.edusign.com/reference/getv1appsparameters.md): Used to get the parameters of an App' installed in the school. The parameters are user-defined. Only the API Key linked to the app can retrieve the parameters.
  - [Get a school application details](https://developers.edusign.com/reference/getv1appsproject.md): Used to get an App' installed in the school
  - [Get public marketplace applications](https://developers.edusign.com/reference/getv1appspublic.md): Used to get public marketplace applications list
  - [Get a public marketplace application details](https://developers.edusign.com/reference/getv1appspublicappid.md): Used to get an marketplace application details
- Attachments
  - [Delete an attachment](https://developers.edusign.com/reference/deletev1attachmentsattachmentid.md): Delete a single attachment (hard delete).
  - [Get attachment by ID](https://developers.edusign.com/reference/getv1attachmentsattachmentid.md): Retrieve a single attachment using its attachment ID.
  - [Update an Attachment](https://developers.edusign.com/reference/putv1attachmentsattachmentid.md): Updates the properties of a single attachment linked to a resource.
  - [Get all attachments for a resource](https://developers.edusign.com/reference/getv1attachmentsressourcetyperessourceid.md): Retrieve all the attachments linked to a given resource ID (course, student, professor, external).
  - [Add an attachment to a resource](https://developers.edusign.com/reference/postv1attachmentsressourcetyperessourceid.md): Add a new file or a link attachment for a given resource ID (course, student, professor, external).
- Classrooms
  - [Delete a classroom by ID.](https://developers.edusign.com/reference/deletev1classroomsclassroomid.md): Delete a single classroom (hard delete) using its classroom ID.
  - [Update a classroom.](https://developers.edusign.com/reference/putv1classroomsclassroomid.md): Update the name of a single classroom.
  - [Delete a classroom by name.](https://developers.edusign.com/reference/deletev1classroomsdeletebynameclassroomname.md): Delete a single classroom (hard delete) using its classroom name.
  - [Get all classrooms](https://developers.edusign.com/reference/getv1classrooms.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) This is an heavy request, please use this endpoint only when needed. Retrieve all the classrooms of your school.
  - [Create a classroom](https://developers.edusign.com/reference/postv1classrooms.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Create a new classroom for your school.
  - [Get a classroom by name](https://developers.edusign.com/reference/getv1classroomsgetbynameclassroomname.md): Retrieve a single classroom by its name (case insensitive).
- Connectors
  - [Get all connectors logs](https://developers.edusign.com/reference/getv1connectorslogs.md): Retrieve all the logs from the connectors of your school. Logs are sorted by creation date in ascending order by default (oldest first). Use `orderBy` to change the sort direction.
- Courses
  - [Remove a student from a course](https://developers.edusign.com/reference/deletev1courseattendanceid.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Remove a single student from an existing course using both the student and the course ID. Other students linked to the…
  - [Delete a course](https://developers.edusign.com/reference/deletev1courseid.md): Delete a single course (hard delete).
  - [Get a course by ID](https://developers.edusign.com/reference/getv1courseid.md): Retrieve a single course using its course ID. If the course is locked ("LOCKED" : 1) the attendance sheet PDF URL ("ATTENDANCE_LIST_GENERATED") is available.
  - [Get all courses](https://developers.edusign.com/reference/getv1course.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the courses of your school (both locked and unlocked courses). <br><strong style="color:gold">WARNING</strong>…
  - [Create a course](https://developers.edusign.com/reference/postv1course.md): Create a new course. Students listed in the "SCHOOL_GROUP" array will be listed in the created course. <br><strong>NOTE:</strong> You can link more teachers by adding fields PROFESSOR_X (where X is…
  - [Get course ID by API ID](https://developers.edusign.com/reference/getv1coursegetidapiid.md): Retrieve a single course ID using its API ID.
  - [Get a professor signature link on a course](https://developers.edusign.com/reference/getv1coursegetprofessorssignaturelinkscourseid.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve the signature link(s) of a professor(s) linked to a course.This endpoint is useful for Edusign integrations, you…
  - [Get a student signature QR Code on a course](https://developers.edusign.com/reference/getv1coursegetqrcodecourseidprofessorid.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve the signature QR Code of a student linked to a course. Both the course and the professor ID (professor linked to…
  - [Get the students signatures links on a date range](https://developers.edusign.com/reference/getv1coursegetsignaturelinksbyrangestartend.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve the signature link(s) of all your students between a time range. This endpoint is useful for Edusign integrations,…
  - [Get a student signature link on a course](https://developers.edusign.com/reference/getv1coursegetsignaturelinkscourseid.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve the signature link(s) of a student(s) linked to a course. This endpoint is useful for Edusign integrations, you can…
  - [Generate a presential sheet for a group on a date range](https://developers.edusign.com/reference/getv1coursegetgroupattendancesheetgroupid.md): Generate and retrieve a presential sheet PDF for a group between a date range.
  - [Lock a course](https://developers.edusign.com/reference/getv1courselockcourseid.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Lock a single course (prevent students signatures and allow to generate presential sheets). <br><strong…
  - [Generate a PIN code for a course](https://developers.edusign.com/reference/getv1coursepincourseid.md): Generate and retrieve a PIN code used for student attendance <a href="https://help.edusign.fr/fr/articles/4742580-faire-emarger-par-code-ou-par-lien-de-partage-vers-la-feuille">(see our Help Center…
  - [Reset student signature for a course](https://developers.edusign.com/reference/getv1coursereloadcourseid.md): Reset the student signatures of a course, existing signature(s) will be removed.
  - [Get a course timestamps](https://developers.edusign.com/reference/getv1coursetimestampscourseid.md): Retrieve a course timestamps (horodatage) including the following elements :  - DEVICE_MODEL : Device used by the student to sign - SIGNATURE : The image signature link for a student
  - [Verify a course QR Code](https://developers.edusign.com/reference/getv1courseverifyqrcodecourseidqrcode.md): Verify the validity of a QR Code linked to a course. <br><strong style="color:gold">WARNING</strong> The QR Code regenerates every 5 seconds with a rest time of 5 seconds, so this API call should be…
  - [Update a course](https://developers.edusign.com/reference/patchv1course.md): Update a single course informations. <br><strong style="color:gold">WARNING</strong> When updating a course, every field will be updated, even if you don't provide a value for them. For instance if…
  - [Set absences between Edusign and an ERP](https://developers.edusign.com/reference/patchv1coursesetabsencessentcourseid.md): Set absences between Edusign and a homemade ERP.
  - [Unlock a course](https://developers.edusign.com/reference/patchv1courseunlockcourseid.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Unlock a single locked course. <br><strong style="color:gold">WARNING</strong> This is an heavy request, a special delay is…
  - [Send signature emails](https://developers.edusign.com/reference/postv1coursesendsignemails.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Send signature emails to student(s) and/or professor(s) of a course. At least one of the two parameters (student or…
  - [Add a student to a course](https://developers.edusign.com/reference/putv1courseattendancecourseid.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Add a single student to an existing course using both the student and the course ID. Other students linked to the course…
- Deprecated
  - [Archive a document](https://developers.edusign.com/reference/deletev1documentv2deletedocumentdocumentid.md): Archive a single document (soft delete for 30 days, then hard delete).
  - [Get a justified absence by ID](https://developers.edusign.com/reference/getv1courseabsenceabsenceid.md): Retrieve a single justified absence using its ID.
  - [Get all documents](https://developers.edusign.com/reference/getv1documentcustom.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the documents of your school (with and without signature). This endpoint will retrieve only the metadata of…
  - [Get all document templates](https://developers.edusign.com/reference/getv1documentcustomtemplates.md): Retrieve all the document templates of your school. The template "TYPE" field defines if it's a document with or without signature : - "1" : Template of a document without signature - "2" : Template…
  - [Get a document template by ID](https://developers.edusign.com/reference/getv1documentcustomtemplatesid.md): Retrieve a single document template using its template ID. The template "TYPE" field defines if it's a document with or without signature : - "1" : Template of a document without signature - "2" :…
  - [Get a document by ID](https://developers.edusign.com/reference/getv1documentv2documentid.md): Retrieve a single document using its document ID.
  - [Send a document for signature](https://developers.edusign.com/reference/postv1documentcustomsendtemplateid.md): Send a document for signature to student(s). In order to add an admin signature in the document, provide an admin_signature image URL. Provide the <b>templateId</b>, <b>students ID array</b>,…
  - [Send a document without template](https://developers.edusign.com/reference/postv1documentv2sendbase64.md): This endpoint permit to send a document to student(s) and external signatories. You must provide the ID of the template, the <b>user_id</b> of the school administration who send the documents, and…
  - [Send a document template to sign](https://developers.edusign.com/reference/postv1documentv2sendtemplate.md): BETA - Will change in the next updates -  This endpoint permit to send a document to student(s) and external signatories. You must provide the ID of the template, the <b>user_id</b> of the school…
- Documents
  - [Create a document using base64](https://developers.edusign.com/reference/createdocumentbybase64.md): Allows the creation of a document from A to Z. Convert your PDF to base64, add signatories, fields at the position of your choice, and attach documents if necessary. <br><br> <strong style="color:…
  - [Get all documents](https://developers.edusign.com/reference/getdocuments.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the documents of your school (with and without signature). The "TYPE" field define if the retrieved document is…
  - [Create a Document Using an Existing Template](https://developers.edusign.com/reference/createdocumentbytemplateid.md): Allows the creation of a document using an existing template by providing the template ID in the request parameters. <br><br> <strong style="color: royalblue">INFO</strong> This method only allows…
  - [Archive a document](https://developers.edusign.com/reference/deletedocument.md): Archive a single document (soft delete for 30 days, then hard delete).
  - [Get a document by ID](https://developers.edusign.com/reference/getdocumentbyid.md): Retrieve a single document using its document ID.
  - [Delete a document template](https://developers.edusign.com/reference/deletetemplate.md): Delete a single document template (hard delete).
  - [Get a template by Document ID](https://developers.edusign.com/reference/gettemplatebyid.md): Retrieve a document template using a document ID. The template "TYPE" field defines if it's a document with or without signature :  - "1" : Template of a document without signature - "2" : Template…
  - [Get all directories](https://developers.edusign.com/reference/getdirectories.md): Retrieve all the document directories of your school. TYPE=1 children include CARBON_COPY ({id, category, name, email}[] or null for historical records); DOCUMENT_SENT indicates publication, not…
  - [Get a directory by ID](https://developers.edusign.com/reference/getdirectorybyid.md): Retrieve a single document directory using its directory ID. TYPE=1 children include CARBON_COPY ({id, category, name, email}[] or null for historical records); DOCUMENT_SENT indicates publication,…
  - [Get template by document ID](https://developers.edusign.com/reference/getdocumenttemplatebyid.md)
  - [Get all templates](https://developers.edusign.com/reference/gettemplates.md): Retrieve all the document templates of your school. The template "TYPE" field defines if it's a document with or without signature :  - "1" : Template of a document without signature - "2" : Template…
  - [Generate a professor course summary between two dates](https://developers.edusign.com/reference/postv1documentprofessorcoursesbetweendates.md): Generate a PDF document course summary for a given professor between two dates.
  - [Generate a student course summary between two dates](https://developers.edusign.com/reference/postv1documentstudentcoursesbetweendates.md): Generate a PDF document course summary for a given student between two dates.
  - [Convert PDF to images](https://developers.edusign.com/reference/convertpdftoimages.md): Convert a PDF document to images for the document editor
  - [Get document to sign by ID for editing](https://developers.edusign.com/reference/getdocumenttosignforediting.md): Retrieve a document to sign by ID with inputs for editing. Document must be generated (DOCUMENT_URL must exist).
  - [Regenerate document with new inputs](https://developers.edusign.com/reference/regeneratedocument.md): Regenerate a document PDF with updated inputs
  - [Update document inputs](https://developers.edusign.com/reference/updatedocumentinputs.md): Update the inputs field for a document to sign
- Events
  - [Delete a single event](https://developers.edusign.com/reference/deletev1eventsid.md): <p>Permanently deletes a single event from your school's system.</p> <p><strong>What this endpoint does:</strong></p> <ul>   <li>Permanently removes the event from the database</li>…
  - [Get a single event by ID](https://developers.edusign.com/reference/getv1eventsid.md): <p>Retrieves detailed information about a specific event.</p> <p><strong>What this endpoint does:</strong></p> <ul>   <li>Fetches a single event with all its details</li>   <li>Includes complete…
  - [Update an existing event](https://developers.edusign.com/reference/patchv1eventsid.md): <p>Updates an existing event with new information.</p> <p><strong>What this endpoint does:</strong></p> <ul>   <li>Updates only the fields you specify (partial update)</li>   <li>Creates new…
  - [Delete multiple events in batch](https://developers.edusign.com/reference/deletev1eventsmass.md): <p>Deletes multiple events efficiently in a single request.</p> <p><strong>What this endpoint does:</strong></p> <ul>   <li>Deletes multiple events and all their associations (students,…
  - [Add multiple events in batch](https://developers.edusign.com/reference/postv1eventsmass.md): <p>Creates multiple events in a single request for better performance.</p> <p><strong>What this endpoint does:</strong></p> <ul>   <li>Creates multiple events efficiently with optimized database…
  - [Get all events](https://developers.edusign.com/reference/getv1events.md): <p>This endpoint retrieves a paginated list of all events for your school.</p> <p><strong>What this endpoint does:</strong></p> <ul>   <li>Supports various filtering options to find specific…
  - [Add a new event](https://developers.edusign.com/reference/postv1events.md): <p>Creates a new event in your school's system.</p> <p><strong>What this endpoint does:</strong></p> <ul>   <li>Creates a new event with the provided information</li>   <li>Creates classrooms if they…
- Externals
  - [Archive an external](https://developers.edusign.com/reference/deletev1externalsexternalid.md): Archive a single external (soft delete).
  - [Get an external by id](https://developers.edusign.com/reference/getv1externalsexternalid.md): Retrieve a single external using its external ID.
  - [Delete an external variable](https://developers.edusign.com/reference/deletev1externalsvariablesvariableid.md): Delete a single variable (or custom field) and the values it contains for each external. A variable belongs to a school and can be used by resources within Edusign (such as a student, a professor, a…
  - [Get all external contacts](https://developers.edusign.com/reference/getv1externals.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the active externals of your school (without the archived externals). <br><strong…
  - [Update an external](https://developers.edusign.com/reference/patchv1externals.md): Un contact externe est par exemple un maitre d'apprentissage, un signataire externe de document...
  - [Create an external](https://developers.edusign.com/reference/postv1externals.md): Un contact externe est par exemple un maitre d'apprentissage, un signataire externe de document...
  - [Get an external by email](https://developers.edusign.com/reference/getv1externalsbyemailemail.md): Retrieve a single external using its email address.
  - [Get an external's variables](https://developers.edusign.com/reference/getv1externalsexternalidvariables.md): Retrieve an array of variables (or custom fields) for an external. A variable belongs to a school and can be used by resources within Edusign (such as a student, a professor, a group or an external).
  - [Create an external variable](https://developers.edusign.com/reference/postv1externalsexternalidvariables.md): Create a new variable and assign a value for it for each external. A variable belongs to a school and can be used by resources within Edusign (such as a student, a professor, a group or an external).
  - [Update an external variable](https://developers.edusign.com/reference/patchv1externalsexternalidvariablesvariableid.md): Update an external variable using its variable ID.
- Groups
  - [Archive a group](https://developers.edusign.com/reference/deletev1groupgroupid.md): Archive a single group (soft delete).
  - [Get a group by id](https://developers.edusign.com/reference/getv1groupgroupid.md): Retrieve a single group using its group ID.
  - [Delete a group variable](https://developers.edusign.com/reference/deletev1groupvariablesvariableid.md): Delete a single variable (or custom field) and the values it contains for each group linked to it. When a group is linked to a variable, the variable ID can be retrieved through the group with the…
  - [Get all groups](https://developers.edusign.com/reference/getv1group.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the active groups of your school (without the archived groups). <br><strong style="color:gold">WARNING</strong>…
  - [Create a group](https://developers.edusign.com/reference/postv1group.md): Create a new group.
  - [Get a group by name](https://developers.edusign.com/reference/getv1groupgetbynamegroupname.md): Retrieve a single group using its group name.
  - [Get group ID by API ID](https://developers.edusign.com/reference/getv1groupgetidapiid.md): Retrieve a single group ID using its API ID.
  - [Get a group's variables](https://developers.edusign.com/reference/getv1groupgroupidvariables.md): Retrieve an array of variables (or custom fields) linked to a group.
  - [Create a group variable](https://developers.edusign.com/reference/postv1groupgroupidvariables.md): Create a new variable and assign a value for it for a group.
  - [Update a group](https://developers.edusign.com/reference/patchv1group.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Update a single group informations. <br><strong style="color:gold">WARNING</strong> : This is an heavy request, please use…
  - [Update a group variable](https://developers.edusign.com/reference/patchv1groupgroupidvariablesvariableid.md): Update a group variable using its variable ID.
- Presential_States
  - [Set an absence for a student](https://developers.edusign.com/reference/patchv1presentialstatessetabsentcourseidstudentid.md): Set a single absence for a student in a given course (course must be unlocked).
  - [Create a comment for a student.](https://developers.edusign.com/reference/patchv1presentialstatessetcommentcourseidstudentid.md): Create a single comment for a student in a given course (course must be unlocked). Comments can be displayed or hidden on the courses PDF generated within Edusign.
  - [Set a delay for a student](https://developers.edusign.com/reference/patchv1presentialstatessetdelaycourseidstudentid.md): Set a single delay for a student in a given course (course must be unlocked).
  - [Set an early departure for a student](https://developers.edusign.com/reference/patchv1presentialstatessetearlydeparturecourseidstudentid.md): Set an early departure for a student in a given course (course must be unlocked).
  - [Set an exclusion for a student](https://developers.edusign.com/reference/patchv1presentialstatessetexclusioncourseidstudentid.md): Set an exclusion for a student in a given course (course must be unlocked).
  - [Set a presence for a student - Only for courses without signature.](https://developers.edusign.com/reference/patchv1presentialstatessetpresentcourseidstudentid.md): Set a presence for a student in a given course (course must be unlocked). <a href="https://help.edusign.fr/fr/articles/8523232-assiduite-sans-signature-tout-ce-qu-il-faut-savoir">This endpoint can be…
- Professors
  - [Archive a professor](https://developers.edusign.com/reference/deletev1professorprofessorid.md): Archive a single professor (soft delete). <br><strong style="color:gold">WARNING</strong> : Never delete a professor linked to a group or a course.
  - [Get a professor by id](https://developers.edusign.com/reference/getv1professorprofessorid.md): Retrieve a single professor using its professor ID.
  - [Delete a professor variable](https://developers.edusign.com/reference/deletev1professorvariablesvariableid.md): Delete a single variable (or custom field) and the values it contains for each professor linked to it. When a professor is linked to a variable, the variable ID can be retrieved through the professor…
  - [Get all professors](https://developers.edusign.com/reference/getv1professor.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the active professors of your school (without the archived professors). <br><strong…
  - [Create a professor](https://developers.edusign.com/reference/postv1professor.md): Create a new professor.
  - [Get a professor by email](https://developers.edusign.com/reference/getv1professorbyemailemail.md): Retrieve a single professor using its email address.
  - [Get professor ID by API ID](https://developers.edusign.com/reference/getv1professorgetidapiid.md): Retrieve a single professor ID using its API ID.
  - [Get a professor's variables](https://developers.edusign.com/reference/getv1professorprofessoridvariables.md): Retrieve an array of variables (or custom fields) linked to a professor.
  - [Create a professor variable](https://developers.edusign.com/reference/postv1professorprofessoridvariables.md): Create a new variable and assign a value for it for a professor.
  - [Update a professor](https://developers.edusign.com/reference/patchv1professor.md): Update a single professor informations. <br><strong style="color:gold">WARNING</strong> : When updating a professor, every field will be updated, even if you don't provide a value for them. For…
  - [Update a professor variable](https://developers.edusign.com/reference/patchv1professorprofessoridvariablesvariableid.md): Update a professor variable using its variable ID.
- School
  - [Get a school](https://developers.edusign.com/reference/getv1school.md): Retrieve a list of informations (name, adress, logo, number of signatures, absences types, etc.) regarding a school account on Edusign.
  - [Update a school](https://developers.edusign.com/reference/patchv1school.md): Update a single school informations. <br>Signature email validity is configured in School settings. This endpoint does not allow updating DISABLE_TIME_LIMIT_TO_SIGN_EMAIL,…
  - [Get a school's daily courses](https://developers.edusign.com/reference/getv1schooldailycoursesschoolid.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all of the courses of a school for the actual day. This endpoint is mainly used to display data on school's…
- Students
  - [Unlink an external contact to a student](https://developers.edusign.com/reference/deletev1studentexternalrelationstudentidexternalid.md): Unlink an external contact (such as a tutor) linked to a student. When a student is linked to an external contact, the external contact ID can be retrieved through the student with the…
  - [Archive a student](https://developers.edusign.com/reference/deletev1studentstudentid.md): Archive a single student (soft delete).
  - [Get a student by ID](https://developers.edusign.com/reference/getv1studentstudentid.md): Retrieve a single student using its student ID.
  - [Delete a student variable](https://developers.edusign.com/reference/deletev1studentvariablesvariableid.md): Delete a single variable (or custom field) and the values it contains for each student linked to it. When a student is linked to a variable, the variable ID can be retrieved through the student with…
  - [Get all students](https://developers.edusign.com/reference/getv1student.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the active students of your school (without the archived students). <br><strong…
  - [Create a student](https://developers.edusign.com/reference/postv1student.md): Create a new student.
  - [Get a student by email](https://developers.edusign.com/reference/getv1studentbyemailemail.md): Retrieve a single student using its email address.
  - [Get external contacts of a student](https://developers.edusign.com/reference/getv1studentexternalrelationstudentid.md): Retrieve an array of external contacts (such as a tutor) linked to a student.
  - [Link an external contact to a student](https://developers.edusign.com/reference/postv1studentexternalrelationstudentid.md): Link a single external contact (such as a tutor) to a student.
  - [Get student ID by API ID](https://developers.edusign.com/reference/getv1studentgetidapiid.md): Retrieve a single student ID using its API ID.
  - [Restore a student](https://developers.edusign.com/reference/getv1studentrestorestudentid.md): Restore a single archived student.
  - [Get a student's variables](https://developers.edusign.com/reference/getv1studentstudentidvariables.md): Retrieve an array of variables (or custom fields) linked to a student.
  - [Create a student variable](https://developers.edusign.com/reference/postv1studentstudentidvariables.md): Create a new variable and assign a value for it for a student.
  - [Update a student](https://developers.edusign.com/reference/patchv1student.md): Update a single student informations. <br><strong style="color:gold">WARNING</strong> : When updating a student, every field will be updated, even if you don't provide a value for them. For instance…
  - [Update a student variable](https://developers.edusign.com/reference/patchv1studentstudentidvariablesvariableid.md): Update a student variable using its variable ID.
  - [Send an attendance report](https://developers.edusign.com/reference/postv1studentattendancereportsend.md): Send the attendance report of an array of students. - Need <strong>UPDATE</strong> right for doing this request - The array of students is limited to 10 maximum per call. - If the request is too…
  - [Retrieve students by identifiers](https://developers.edusign.com/reference/postv1studentbyids.md): Retrieves a list of students using their Edusign identifiers.
  - [Get a student attendance summary](https://developers.edusign.com/reference/postv1studenthoursofpresencestudentid.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Permit to get the number of hours of presence, justified absence and unjustified absences of a student between two dates
- Surveys
  - [Delete a survey](https://developers.edusign.com/reference/deletev1surveyssurveyid.md): Delete a single survey (hard delete).
  - [Get a survey by ID](https://developers.edusign.com/reference/getv1surveyssurveyid.md): Retrieve a single survey using its survey ID.
  - [Get all surveys](https://developers.edusign.com/reference/getv1surveys.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the surveys of your school. <br><strong style="color:gold">WARNING</strong>  This is an heavy request, please…
  - [Create a survey](https://developers.edusign.com/reference/postv1surveys.md): Create a new survey. A survey can be scheduled to be sent using the "sending_date" field. At least one of the following arrays must be provided: students, professors, or externals. You don't need to…
  - [Get all surveys templates](https://developers.edusign.com/reference/getv1surveystemplates.md): Retrieve all the surveys templates of your school.
  - [Generate a PDF survey](https://developers.edusign.com/reference/postv1surveysgenerate.md): Generate a PDF survey based on the answers of the participants.
  - [Send a survey completion reminder](https://developers.edusign.com/reference/postv1surveysremindersurveyid.md): Send an email completion reminder to the participants who haven't answered yet.
- Trainings
  - [Archive a training](https://developers.edusign.com/reference/deletev1trainingstrainingid.md): Archive a single training (soft delete). It will also archive the courses linked to it.
  - [Get a training](https://developers.edusign.com/reference/getv1trainingstrainingid.md): Retrieve a single training using its training ID.
  - [Update a training](https://developers.edusign.com/reference/putv1trainingstrainingid.md): Update a single training informations.
  - [Get all trainings](https://developers.edusign.com/reference/getv1trainings.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the trainings of your school (non-archived trainings only). <br><strong style="color:gold">WARNING</strong>…
  - [Create a training](https://developers.edusign.com/reference/postv1trainings.md): Create a new training.
  - [Get training ID by API ID](https://developers.edusign.com/reference/getv1trainingsgetidapiid.md): Retrieve a single training ID using its API ID.
  - [Remove students or professors from a training](https://developers.edusign.com/reference/patchv1trainingsresourcestrainingid.md): Remove students or professors from an existing training. If students are removed from a training, they will be removed from the future resources of the training such as attendance sheets, documents…
  - [Add students or professors to a training](https://developers.edusign.com/reference/postv1trainingsresourcestrainingid.md): Add students or professors to an existing training.  **Without `options`, the students are also added to every future attendance sheet, document and survey of the training.** "Future" covers every…
  - [Restore a training](https://developers.edusign.com/reference/patchv1trainingsunarchivetrainingid.md): Restore a single archived training.
- Users
  - [Delete a user](https://developers.edusign.com/reference/deletev1usersuserid.md): Delete a user of Edusign's school platform (hard delete).
  - [Get a user](https://developers.edusign.com/reference/getv1usersuserid.md): Get a school-platform admin user by its ID. PERMISSIONS describes the user's permission level, not the API key's access rights: 0 = Analyst, 1 = User, 4 = Admin, 5 = Owner. Values 2 and 3 are…
  - [Get all users](https://developers.edusign.com/reference/getv1users.md): ![Alt Text](https://edusign-cdn.s3.eu-west-3.amazonaws.com/images/red.jpg) Retrieve all the users of the Edusign's school platform. <br><strong style="color:gold">WARNING</strong> This is an heavy…
  - [Create a user](https://developers.edusign.com/reference/postv1users.md): Add a new admin user to Edusign. The user will receive an email to set-up its password. Various access levels can be given to a user with permissions. Existing creation defaults remain: API_ACCESS…
  - [Update a user permission level](https://developers.edusign.com/reference/postv1userschangepermissions.md): Update a user permission level, available values are : <br /> - "0" : Analyst <br /> - "1" : User <br /> - "4" : Admin <br /> - "5" : Owner (cannot be assigned through this endpoint)
  - [Get supported user feature permissions](https://developers.edusign.com/reference/getv1usersfeatures.md): Requires USERS read access. Returns boolean user/all-scope feature names accepted by FEATURE_PERMISSIONS. CAN_UPDATE reflects this API key's USERS write access and, for API_ACCESS, APPS write access;…
  - [Update a user's feature and audience settings](https://developers.edusign.com/reference/patchv1usersuseridpermissions.md): Requires USERS write access; delegated OAuth tokens remain read-only for USERS. At least one field is required; unknown fields are rejected. Changes are atomic. Omitted settings and the user's…
- Utils
  - [Get inputs from an Adobe document](https://developers.edusign.com/reference/getadobeinputs.md): Retrieve the x/y position of a signature field in an Adobe document. Retrieving a signature position allows you to replace it easily in a document with signature generated within Edusign.
  - [Get inputs from a text document](https://developers.edusign.com/reference/gettextinputs.md): Retrieve the x/y position of a field between brackets in a text document. For instance the [SIGNATURE_ADMIN] field. Retrieving a signature position allows you to replace it easily in a document with…
  - [Get all input types from an Adobe document](https://developers.edusign.com/reference/getadobeinputsall.md): Retrieve the x/y position of all form fields in an Adobe document with optional filtering by field type. This endpoint supports all PDF form field types including text fields, checkboxes, signatures,…

## API Reference: EduSign API Next
- Courses
  - [Create a new course](https://developers.edusign.com/reference/post_courses.md): Create a single course session and add provided professors to it. At least one professor is required.  **Date formats:** `startDateTime` and `endDateTime` must be ISO 8601 with a timezone designator…
  - [Get all courses with filters](https://developers.edusign.com/reference/get_courses.md): Retrieve all the courses of your school (both archived and not archived courses). To filter by lists of IDs or sort the results, POST <a…
  - [Get a course by ID](https://developers.edusign.com/reference/get_courses-id.md): Retrieve a single course using its course ID.
  - [Partially update a course](https://developers.edusign.com/reference/patch_courses-id.md): Update only the fields you explicitly provide. Omitted fields remain unchanged. Use this instead of PATCH /v1/course/ to avoid destructive full-replace behaviour.
  - [Batch create or update courses](https://developers.edusign.com/reference/post_courses-batch-upsert.md): Upsert up to 1000 courses in a single request. Returns 200 when all items succeed, 207 for partial success with per-item failures.  **Resolution logic:** - `courseId` provided → strict update by…
  - [Assign students to a course](https://developers.edusign.com/reference/put_courses-id-students.md): Assign students and/or groups to a single course. Uses replace semantics: provided student/group lists replace existing enrollments. Omitted fields remain unchanged.  **XOR rules:** - `studentIds`…
  - [[BETA] Assign students to a course by external reference ID](https://developers.edusign.com/reference/put_courses-by-reference-id-externalreferenceid-students.md): Assign students and/or groups to a single course, identified by its external reference ID. Uses replace semantics: provided student/group lists replace existing enrollments. Omitted fields remain…
  - [[BETA] Partially update a course by external reference ID](https://developers.edusign.com/reference/patch_courses-by-reference-id-externalreferenceid.md): Same partial-update semantics as PATCH /courses/:id but identified by the external reference ID (apiId) set by your ERP.
  - [Delete teachers from a course](https://developers.edusign.com/reference/delete_courses-id-teachers.md): Delete teachers from a course using its course ID.
  - [[BETA] Search courses with filters in the request body](https://developers.edusign.com/reference/post_courses-search.md): Retrieve all the courses of your school (both archived and not archived courses).
  - [[BETA] Archive a course by ID](https://developers.edusign.com/reference/delete_courses-id.md): Archive a course by its Edusign id: the course is locked (`isArchived: true` on the wire), so it leaves the active views and accepts no further edit or signature. This is the explicit v3 counterpart…
  - [[BETA] Archive a course by external reference ID](https://developers.edusign.com/reference/delete_courses-by-reference-id-externalreferenceid.md): Archive a course matched by the external reference id (`API_ID`) set by your ERP. Same effects, errors and webhooks as `DELETE /courses/:id`.  The reference is not unique in legacy data, so the rule…
  - [[BETA] Restore an archived course by ID](https://developers.edusign.com/reference/post_courses-id-restore.md): Restore an archived course by its Edusign id: its lock is cleared (`isArchived: false`) and it becomes editable and signable again. This is the explicit v3 counterpart of `PATCH…
  - [[BETA] Restore an archived course by external reference ID](https://developers.edusign.com/reference/post_courses-by-reference-id-externalreferenceid-restore.md): Restore an archived course matched by the external reference id (`API_ID`) set by your ERP. Same effects, errors and webhooks as `POST /courses/:id/restore`.
  - [[BETA] Get a course registration form](https://developers.edusign.com/reference/get_courses-id-registration-form.md): Read or configure an existing course public registration form. The link is stable and is never generated or rotated. Locked courses and courses without a registration link are rejected. Custom fields…
  - [[BETA] Configure a course registration form](https://developers.edusign.com/reference/patch_courses-id-registration-form.md): Read or configure an existing course public registration form. The link is stable and is never generated or rotated. Locked courses and courses without a registration link are rejected. Custom fields…
  - [[BETA] Get a course registration form by external reference ID](https://developers.edusign.com/reference/get_courses-by-reference-id-externalreferenceid-registration-form.md): Read or configure an existing course public registration form. The link is stable and is never generated or rotated. Locked courses and courses without a registration link are rejected. Custom fields…
  - [[BETA] Configure a course registration form by external reference ID](https://developers.edusign.com/reference/patch_courses-by-reference-id-externalreferenceid-registration-form.md): Read or configure an existing course public registration form. The link is stable and is never generated or rotated. Locked courses and courses without a registration link are rejected. Custom fields…
- Trainings
  - [[BETA] Get all trainings with optional filters](https://developers.edusign.com/reference/get_trainings.md): Returns a paginated list of trainings. The query filters are deprecated — use POST <a href="https://developers.edusign.com/reference/post_trainings-search">/trainings:search</a> to filter by ID lists.
  - [[BETA] Batch create or update trainings by external reference ID](https://developers.edusign.com/reference/post_trainings-batch-upsert.md): Upsert up to 1000 trainings in a single request. Matches by trainingId or externalReferenceId within school scope; items without either are always created. Update semantics: scalar fields are a…
  - [[BETA] Add a course to a training program](https://developers.edusign.com/reference/post_trainings-trainingid-courses-courseid.md): Link an existing course to a training program. If the course dates fall outside the training date range, training dates are automatically extended.
  - [[BETA] Get a training by ID](https://developers.edusign.com/reference/get_trainings-id.md): Retrieve a single training using its training ID.
  - [[BETA] Get a training registration form](https://developers.edusign.com/reference/get_trainings-id-registration-form.md): Read the current registration link and form configuration for a training. Archived trainings are rejected with ARCHIVED_TRAINING_EXISTS: registration is impossible on them, so their link is never…
  - [[BETA] Configure a training registration form](https://developers.edusign.com/reference/put_trainings-id-registration-form.md): Configure the training public registration form (full replacement).  - The returned URL is derived from the training immutable inscription hash and never changes across calls. - `firstName` and…
  - [[BETA] Get a training registration form by external reference ID](https://developers.edusign.com/reference/get_trainings-by-reference-id-externalreferenceid-registration-form.md): Read the current registration link and form configuration for a training addressed by external reference ID. Archived trainings are rejected with ARCHIVED_TRAINING_EXISTS: registration is impossible…
  - [[BETA] Configure a training registration form by external reference ID](https://developers.edusign.com/reference/put_trainings-by-reference-id-externalreferenceid-registration-form.md): Configure the training public registration form (full replacement).  - The returned URL is derived from the training immutable inscription hash and never changes across calls. - `firstName` and…
  - [[BETA] Search trainings with filters in the request body](https://developers.edusign.com/reference/post_trainings-search.md): Read-only search over trainings: same filters, semantics and paginated response as GET /trainings, carried in a JSON body so large ID lists (up to 1000 trainingIds or trainingExternalReferenceIds)…
  - [[BETA] Restore an archived training by ID](https://developers.edusign.com/reference/post_trainings-id-restore.md): Restore a previously archived training by its internal Edusign ID: its ARCHIVED flag is cleared and it becomes active again. Linked courses that were locked when the training was archived stay…
  - [[BETA] Restore an archived training by external reference ID](https://developers.edusign.com/reference/post_trainings-by-reference-id-externalreferenceid-restore.md): Restore a previously archived training identified by its external reference ID (apiId): its ARCHIVED flag is cleared and it becomes active again. Linked courses that were locked when the training was…
  - [[BETA] Archive a training by ID](https://developers.edusign.com/reference/delete_trainings-id.md): Archives a training in the current school and locks all of its courses. Returns the training id, optional externalReferenceId, and archive metadata. Fires an on_training_archived webhook, plus one…
  - [[BETA] Archive a training by external reference ID](https://developers.edusign.com/reference/delete_trainings-by-reference-id-externalreferenceid.md): Archives a training matched by partner externalReferenceId (API_ID). Same response and error semantics as DELETE /trainings/:id.  <div style="margin:8px 0;padding:12px 16px;border:1px solid…
  - [[BETA] Generate and download a collective training attendance PDF](https://developers.edusign.com/reference/post_trainings-trainingid-attendance-sheet-generate.md): Requires the training feature and authenticated API-key or OAuth access. API keys need TRAININGS, COURSES and STUDENTS read permissions; generation also requires TRAININGS write permission. OAuth…
  - [[BETA] List sessions for a training attendance PDF](https://developers.edusign.com/reference/get_trainings-trainingid-attendance-sheet-courses.md): Requires the training feature and authenticated API-key or OAuth access. API keys need TRAININGS, COURSES and STUDENTS read permissions; generation also requires TRAININGS write permission. OAuth…
  - [[BETA] Summarize selected training attendance sessions](https://developers.edusign.com/reference/post_trainings-trainingid-attendance-sheet-preview.md): Requires the training feature and authenticated API-key or OAuth access. API keys need TRAININGS, COURSES and STUDENTS read permissions; generation also requires TRAININGS write permission. OAuth…
  - [[BETA] Summarize the archived sessions of a training](https://developers.edusign.com/reference/get_trainings-trainingid-attendance-sheet.md): Requires the training feature and authenticated API-key or OAuth access. API keys need TRAININGS, COURSES and STUDENTS read permissions; generation also requires TRAININGS write permission. OAuth…
- Students
  - [Create a new student](https://developers.edusign.com/reference/post_students.md): Create a single student.
  - [Get all students with pagination and filters](https://developers.edusign.com/reference/get_students.md): Get all students with pagination and filters
  - [[BETA] Bulk upsert student cards](https://developers.edusign.com/reference/post_students-cards-bulkupsert.md): Create or update, 1000 max at once, student cards in a single operation. Supports both Student card Partner identifier only and full card information.
  - [[BETA] Link externals to students by Edusign student ID](https://developers.edusign.com/reference/put_students-link-externals.md): Replace externals linked to students in batch. Up to 500 students per request, up to 50 externals per student.
  - [[BETA] Link externals to students by student external reference id](https://developers.edusign.com/reference/put_students-link-externals-by-reference-id.md): Replace externals linked to students in batch, keyed by student external reference ID. Up to 500 students per request, up to 50 externals per student.
  - [Get a student by ID](https://developers.edusign.com/reference/get_students-id.md): Get a student by ID
  - [[BETA] Archive a student by Edusign id](https://developers.edusign.com/reference/delete_students-id.md): Hides (archives) a student in the current school. Returns the student id, optional externalReferenceId, and archive metadata. Fires on_student_deleted and on_student_archived webhooks asynchronously…
  - [[BETA] Search for a student by email, external reference ID or username (deprecated)](https://developers.edusign.com/reference/post_students-search.md): Deprecated: to find a student by external reference ID, use GET <a href="https://developers.edusign.com/reference/get_students-by-reference-id-externalreferenceid">/students/by-reference-id/{externalR…
  - [[BETA] Restore a student by ID](https://developers.edusign.com/reference/post_students-id-restore.md): Restore a student by ID
  - [[BETA] Archive a student by external reference id](https://developers.edusign.com/reference/delete_students-by-reference-id-externalreferenceid.md): Hides (archives) a student matched by partner externalReferenceId (API_ID). Same response and error semantics as DELETE /students/:id.  **Warning:** Archiving a student also removes them from future…
  - [[BETA] Restore a student by external reference ID](https://developers.edusign.com/reference/post_students-by-reference-id-externalreferenceid-restore.md): Restore a student by external reference ID
  - [Batch create or update students](https://developers.edusign.com/reference/post_students-batch-upsert.md): Create or update multiple students in a single request with partial success support. Each item is matched by either `studentId` (EduSign internal ID, update only) or `externalReferenceId`…
  - [[BETA] Partially update a student by ID](https://developers.edusign.com/reference/patch_students-id.md): Partially update a student addressed by its Edusign id.  Only provided fields are modified.  - If a field is set to `null` → its value is reset. - If a field is not provided → partial update, the…
  - [[BETA] Partially update a student by external reference ID](https://developers.edusign.com/reference/patch_students-by-reference-id-externalreferenceid.md): Partially update a student addressed by your external reference id.  Only provided fields are modified.  - If a field is set to `null` → its value is reset. - If a field is not provided → partial…
  - [Get a student by external reference ID](https://developers.edusign.com/reference/get_students-by-reference-id-externalreferenceid.md): Retrieve a single student using the external reference ID your system gave it. Archived students are returned too. Returns 404 (`STUDENT_NOT_FOUND`) when no student of your school carries that…
- Assessments
  - [[BETA] List assessments](https://developers.edusign.com/reference/get_assessments.md): Retrieve a paginated list of assessments with optional filtering
  - [Create assessment](https://developers.edusign.com/reference/post_assessments.md): Create a new assessment
  - [[BETA] Get assessment by ID](https://developers.edusign.com/reference/get_assessments-id.md): Retrieve a single assessment by its unique identifier
  - [[BETA] Update assessment](https://developers.edusign.com/reference/patch_assessments-id.md): Update an existing assessment
  - [[BETA] Delete assessment](https://developers.edusign.com/reference/delete_assessments-id.md): Delete an assessment by its unique identifier
- Assessment Submissions
  - [List assessment submissions](https://developers.edusign.com/reference/get_assessment-submissions.md): Retrieve a paginated list of assessment submissions with optional filtering by status, student, assessment, dates, etc.
  - [Create assessment submission](https://developers.edusign.com/reference/post_assessment-submissions.md): Create a new assessment submission (usually starts as todo)
  - [Get assessment submission by ID](https://developers.edusign.com/reference/get_assessment-submissions-id.md): Retrieve a single assessment submission by its unique identifier
  - [Update assessment submission](https://developers.edusign.com/reference/patch_assessment-submissions-id.md): Update an existing assessment submission.
  - [Delete assessment submission](https://developers.edusign.com/reference/delete_assessment-submissions-id.md): Delete an assessment submission.
  - [Get assessment submissions by student](https://developers.edusign.com/reference/get_assessment-submissions-student-studentid.md): Retrieve all assessment submissions for a specific student
  - [Get assessment submissions by assessment](https://developers.edusign.com/reference/get_assessment-submissions-assessment-assessmentid.md): Retrieve all submissions for a specific assessment
  - [Batch upsert assessment submissions](https://developers.edusign.com/reference/post_assessment-submissions-batch-upsert.md): Create or update up to 1000 assessment submissions in a best-effort batch.
- Professors
  - [Create a professor](https://developers.edusign.com/reference/post_professors.md): Create a new professor in the system.
  - [[BETA] Get all professors](https://developers.edusign.com/reference/get_professors.md): Retrieve all professors from the system.
  - [[BETA] Get a professor by ID](https://developers.edusign.com/reference/get_professors-id.md): Retrieve a professor by their ID.
  - [[BETA] Update a professor](https://developers.edusign.com/reference/patch_professors-id.md): Partial update of professor information. Only provided fields are modified.  - If a field is set to `null` → its value is reset. - If a field is not provided → partial update, the field is ignored.
  - [[BETA] Archive a professor by ID](https://developers.edusign.com/reference/delete_professors-id.md): Soft-removes (archives) a professor for the current school.
  - [[BETA] Archive a professor by external reference ID](https://developers.edusign.com/reference/delete_professors-by-reference-id-externalreferenceid.md): Soft-removes (archives) a professor for the current school by external reference ID.
  - [[BETA] Update a professor by external reference ID](https://developers.edusign.com/reference/patch_professors-by-reference-id-externalreferenceid.md): Partial update of professor information by external reference ID. Only provided fields are modified.  - If a field is set to `null` → its value is reset. - If a field is not provided → partial…
  - [Batch create or update professors](https://developers.edusign.com/reference/post_professors-batch-upsert.md): Upsert up to 1000 professors in a single request. Matches by externalReferenceId, or professorId or email within school scope. Returns 200 for all success, 207 for partial success with failures.
  - [[BETA] Restore an archived professor by ID](https://developers.edusign.com/reference/post_professors-professorid-restore.md): Restores (un-archives) a professor for the current school.
  - [[BETA] Restore an archived professor by external reference ID](https://developers.edusign.com/reference/post_professors-by-reference-id-professorexternalreferenceid-restore.md): Restores (un-archives) a professor for the current school by external reference ID.
- Surveys
  - [[BETA] Get surveys based on filter criterias](https://developers.edusign.com/reference/get_surveys.md): Retrieve the surveys of your school. To filter by lists of IDs or by date ranges, or to sort the results, POST <a…
  - [[BETA] Get a survey by ID](https://developers.edusign.com/reference/get_surveys-id.md): Retrieve a single survey using its survey ID.
  - [[BETA] Create survey template](https://developers.edusign.com/reference/post_survey-templates.md): Create a survey template from a **SurveyJS** schema.  The `survey` field is a raw [SurveyJS](https://surveyjs.io/) survey model (JSON). It is validated against the Edusign scope, then canonicalized…
  - [[BETA] Replace survey template](https://developers.edusign.com/reference/put_survey-templates-id.md): Fully replaces a survey template (metadata + content) by its internal id or external reference id. The `survey` body is the same SurveyJS schema as on create and entirely replaces the previous…
  - [[BETA] Replace survey template by external reference id](https://developers.edusign.com/reference/put_survey-templates-by-reference-id-externalreferenceid.md): Fully replaces a survey template (metadata + content) by its internal id or external reference id. The `survey` body is the same SurveyJS schema as on create and entirely replaces the previous…
  - [[BETA] Archive survey template](https://developers.edusign.com/reference/delete_survey-templates-id.md): Archives (hides) a survey template by its internal id or external reference id. The template is soft-deleted: it is marked hidden and stops being usable for new surveys, but existing data is kept.…
  - [[BETA] Archive survey template by external reference id](https://developers.edusign.com/reference/delete_survey-templates-by-reference-id-externalreferenceid.md): Archives (hides) a survey template by its internal id or external reference id. The template is soft-deleted: it is marked hidden and stops being usable for new surveys, but existing data is kept.…
  - [[BETA] Restore survey template](https://developers.edusign.com/reference/post_survey-templates-id-restore.md): Restores an archived survey template by its internal id or external reference id. The hidden flag is cleared and the template becomes usable for new surveys again. Restoring a template that is…
  - [[BETA] Restore survey template by external reference id](https://developers.edusign.com/reference/post_survey-templates-by-reference-id-externalreferenceid-restore.md): Restores an archived survey template by its internal id or external reference id. The hidden flag is cleared and the template becomes usable for new surveys again. Restoring a template that is…
  - [[BETA] Search surveys](https://developers.edusign.com/reference/post_surveys-search.md): Search the surveys of your school, archived ones included unless `isArchived` says otherwise. This read-only operation uses POST to carry the filters in its body: credentials holding only read access…
  - [[BETA] Search survey templates](https://developers.edusign.com/reference/post_survey-templates-search.md): The survey templates of the school that are not archived, newest first, one page at a time, with the id that identifies each when a survey is sent from it. The questions of a template are not…
- Absences
  - [[BETA] Get all justified absences](https://developers.edusign.com/reference/get_justified-absences.md): Retrieves a list of justified absences with optional filtering parameters:     - Filter by date range (start and end)     - Filter by creation date (lower bound)     - Filter by course ID     -…
  - [[BETA] Get a single justified absence by ID](https://developers.edusign.com/reference/get_justified-absences-id.md): Retrieves detailed information about a specific justified absence
  - [[BETA] List a student’s missed sessions](https://developers.edusign.com/reference/get_absences.md): Retrieve missed sessions for a student in your school, including their attendance status and any linked justification.  ### Choose the student and period  - Provide exactly one of `studentId` or…
- Schools
  - [[BETA] Get the authenticated school settings](https://developers.edusign.com/reference/get_school-settings.md): GET /school/settings returns the authenticated school's complete safe settings in a data object. The representation includes contact details, attendance-sheet presentation, permissions and automation…
  - [[BETA] Partially update the authenticated school settings](https://developers.edusign.com/reference/patch_school-settings.md): PATCH /school/settings updates only the settings you want to change. Send a JSON object with Content-Type: application/json; do not wrap it in data. Use PATCH, not POST. The response contains the…
  - [[BETA] Get a school by ID](https://developers.edusign.com/reference/get_school.md): Get a school by ID
  - [[BETA] Read school-wide booklet tabs](https://developers.edusign.com/reference/get_school-booklet-settings.md): Read school-wide booklet tabs
  - [[BETA] Save school-wide booklet tabs with an expected revision](https://developers.edusign.com/reference/put_school-booklet-settings.md): Save school-wide booklet tabs with an expected revision
  - [[BETA] List the school livret pages, most recently changed first](https://developers.edusign.com/reference/get_school-livret-pages.md): List the school livret pages, most recently changed first
  - [[BETA] Create a livret page as an unpublished draft](https://developers.edusign.com/reference/post_school-livret-pages.md): The HTML is sanitized on the server against a fixed allowlist; the 200 000 character bound applies to the sanitized HTML.
  - [[BETA] Read a livret page with its published face and pending draft](https://developers.edusign.com/reference/get_school-livret-pages-pageid.md): Read a livret page with its published face and pending draft
  - [[BETA] Delete a livret page and remove its booklet tab](https://developers.edusign.com/reference/delete_school-livret-pages-pageid.md): Delete a livret page and remove its booklet tab
  - [[BETA] Save the pending draft of a livret page with an expected version](https://developers.edusign.com/reference/put_school-livret-pages-pageid-draft.md): Readers keep the published version until the draft is published.
  - [[BETA] Publish the pending draft of a livret page with an expected version](https://developers.edusign.com/reference/post_school-livret-pages-pageid-publish.md): Publish the pending draft of a livret page with an expected version
- Subjects
  - [[BETA] Get all subjects with filters](https://developers.edusign.com/reference/get_subjects.md): Retrieve all the subjects of your school with optional filtering and pagination.
  - [Create a new subject](https://developers.edusign.com/reference/post_subjects.md): Create a new subject in your school.
  - [[BETA] Get a subject by ID](https://developers.edusign.com/reference/get_subjects-id.md): Retrieve a single subject using its subject ID.
  - [[BETA] Update a subject](https://developers.edusign.com/reference/patch_subjects-id.md): Update an existing subject by its ID.
  - [[BETA] Delete a subject](https://developers.edusign.com/reference/delete_subjects-id.md): Delete an existing subject by its ID.
- Groups
  - [[BETA] Get all groups with filters](https://developers.edusign.com/reference/get_groups.md): Retrieve all the groups of your school with optional filtering and pagination.
  - [Create a new group](https://developers.edusign.com/reference/post_groups.md): Create a single group resource. Note: Student membership is managed separately via dedicated endpoint. Nullable fields (description, parentId, logo) are stored as empty strings when set to null or…
  - [[BETA] Get a group by ID](https://developers.edusign.com/reference/get_groups-id.md): Retrieve a single group using its group ID.
  - [[BETA] Update a group by internal ID](https://developers.edusign.com/reference/patch_groups-id.md): Update group attributes by internal Edusign ID. Setting nullable fields (description, logo) to null clears them. Parent removal will be handled via dedicated endpoint in future release.
  - [[BETA] Archive (soft-delete) a group by internal ID](https://developers.edusign.com/reference/delete_groups-id.md): Soft-delete a group: it is marked archived (HIDDEN) and detached from its parent. Direct child groups are orphaned (their parent is cleared) but NOT archived or deleted. Student memberships are…
  - [Search for a group (deprecated)](https://developers.edusign.com/reference/post_groups-search.md): Deprecated: to find a group by external reference ID, use GET <a href="https://developers.edusign.com/reference/get_groups-by-reference-id-externalreferenceid">/groups/by-reference-id/{externalReferen…
  - [[BETA] Update a group by external reference ID](https://developers.edusign.com/reference/patch_groups-by-reference-id-externalreferenceid.md): Update group attributes by external reference ID (apiId). Setting nullable fields (description, logo) to null clears them. Parent removal will be handled via dedicated endpoint in future release.
  - [[BETA] Archive (soft-delete) a group by external reference ID](https://developers.edusign.com/reference/delete_groups-by-reference-id-externalreferenceid.md): Soft-delete a group identified by its external reference ID (apiId): it is marked archived (HIDDEN) and detached from its parent. Direct child groups are orphaned (their parent is cleared) but NOT…
  - [Batch create or update groups by external reference ID or internal ID (groupId)](https://developers.edusign.com/reference/post_groups-batch-upsert.md): Upsert up to 1000 groups in a single request. Matches by externalReferenceId or groupId within school scope. Returns 200 when all items succeed, 207 for partial success with per-item failures.…
  - [Batch assign students to groups](https://developers.edusign.com/reference/post_groups-students-batch-upsert.md): Assign students to groups in bulk. Each assignment maps one group (by ID or external reference) to multiple students (by IDs or external references). Returns 200 when all items succeed, 207 for…
  - [[BETA] Replace the students of a group](https://developers.edusign.com/reference/put_groups-id-students.md): Replace the membership of a group with the provided list of students. Students present in the payload but not in the group are added; students currently in the group but absent from the payload are…
  - [[BETA] Replace the students of a group by external reference ID](https://developers.edusign.com/reference/put_groups-by-reference-id-externalreferenceid-students.md): Replace the membership of a group identified by its external reference ID (apiId), with the provided list of students. Students present in the payload but not in the group are added; students…
  - [[BETA] Restore (unarchive) a group by internal ID](https://developers.edusign.com/reference/post_groups-groupid-restore.md): Restore a previously archived group by its internal Edusign ID: its archived (HIDDEN) flag is cleared and it becomes active again. The group is restored as a root group — its previous parent link,…
  - [[BETA] Restore (unarchive) a group by external reference ID](https://developers.edusign.com/reference/post_groups-by-reference-id-groupexternalreferenceid-restore.md): Restore a previously archived group identified by its external reference ID (apiId): its archived (HIDDEN) flag is cleared and it becomes active again. The group is restored as a root group — its…
  - [[BETA] Add students to a group](https://developers.edusign.com/reference/post_groups-id-students.md): Add students to a group, without rewriting its membership. **This endpoint never removes anyone.**  Use it to turn an enrolment event from your system, or a batch of them, into a single call: `PUT…
  - [[BETA] Remove students from a group](https://developers.edusign.com/reference/delete_groups-id-students.md): Remove students from a group, without rewriting its membership. **This endpoint never adds anyone.** The identifiers travel in the request body, so they never appear in access logs.  **Moving a…
  - [[BETA] Add students to a group by external reference ID](https://developers.edusign.com/reference/post_groups-by-reference-id-externalreferenceid-students.md): Add students to a group identified by its external reference ID, without rewriting its membership. **This endpoint never removes anyone.** Same behaviour as `POST /v3/groups/{id}/students`.  **Up to…
  - [[BETA] Remove students from a group by external reference ID](https://developers.edusign.com/reference/delete_groups-by-reference-id-externalreferenceid-students.md): Remove students from a group identified by its external reference ID, without rewriting its membership. **This endpoint never adds anyone.** Same behaviour as `DELETE /v3/groups/{id}/students`,…
  - [Get a group by external reference ID](https://developers.edusign.com/reference/get_groups-by-reference-id-externalreferenceid.md): Retrieve a single group using the external reference ID your system gave it. Archived groups are returned too. Returns 404 (`GROUP_NOT_FOUND`) when no group of your school carries that reference, and…
- NFC
  - [[BETA] List NFC tags](https://developers.edusign.com/reference/get_nfc.md): List the current-generation NFC tags configured for your school and see where and when they can be used.  NFC attendance is an Edusign add-on installed and configured by the Edusign team.  Each tag…
  - [[BETA] Update an NFC tag](https://developers.edusign.com/reference/patch_nfc-id.md): Update the GPS coordinates, classroom, or signing windows of one NFC tag in your school. Send only the fields you want to change; omitted fields keep their current values.  NFC attendance is an…
  - [[BETA] Update multiple NFC tags](https://developers.edusign.com/reference/post_nfc-batch-update.md): Update up to 100 NFC tags in your school in one request. All updates succeed together, or no tags are changed. This endpoint updates existing tags only; it does not create them.  NFC attendance is an…
- Companies
  - [[BETA] Search companies](https://developers.edusign.com/reference/post_companies-search.md): Search the companies of your school. This read-only operation uses POST to carry the filters in its body: credentials holding only read access are served.  Filters sit at the root of the body and are…
  - [[BETA] List companies](https://developers.edusign.com/reference/get_companies.md): List the companies of your school, most recently created first. `search` matches a literal substring of `name`, `displayName` or `businessIdentifier`; `businessIdentifier` is an exact match. To find…
  - [[BETA] Create a company](https://developers.edusign.com/reference/post_companies.md): Create a company in your school. Only `name` is required, and names are not unique: two companies may share one. Unknown fields are refused. Creating a company attaches nobody to it.  **Idempotency:…
  - [[BETA] Get a company](https://developers.edusign.com/reference/get_companies-id.md): Read one company of your school by its Edusign ID. An unknown ID answers `404 COMPANY_NOT_FOUND`.  Several learners and external contacts can be attached to one company, and a change to the company…
  - [[BETA] Update a company](https://developers.edusign.com/reference/patch_companies-id.md): Partially update a company addressed by its Edusign ID.  Only provided fields are modified.  - If a field is set to `null` → its value is reset (`name` cannot be reset). - If a field is not provided…
  - [[BETA] Update a company by external reference ID](https://developers.edusign.com/reference/patch_companies-by-reference-id-externalreferenceid.md): Partially update a company addressed by your own `externalReferenceId`.  Only provided fields are modified.  - If a field is set to `null` → its value is reset (`name` cannot be reset). - If a field…
- Messages
  - [[BETA] Send a push announcement to app users](https://developers.edusign.com/reference/post_messages-announcements.md): Sends an announcement as a push and/or in-app notification, and records it in the "Messages" tab of the school's app. `content` is an array of language variants (`title` + `body` + `language`).…
- Emails
  - [[BETA] Search the emails sent to an address, or those that did not arrive](https://developers.edusign.com/reference/post_emails-search.md): The emails the platform sent for your school, most recent first, with whether each one arrived: those sent to one address (email), or with undelivered: true those that did not arrive, to one address,…
- Documents
  - [[BETA] Remind the pending signers of a document](https://developers.edusign.com/reference/post_documents-to-sign-id-reminders.md): Send the signature request again to the recipients of a document who have not signed yet, by email, and by push for students. When the document is signed in order, only the recipient whose turn it is…
  - [[BETA] Search document templates](https://developers.edusign.com/reference/post_document-templates-search.md): The document templates of the school, by name, one page at a time: the ones to sign (`toSign`) and the ones sent without a signature (`noSign`), each with the id that identifies it. The content of a…
  - [[BETA] Cancel a signature request](https://developers.edusign.com/reference/post_documents-to-sign-id-cancel.md): Cancel an active signature request and notify its recipients using the same rules as the school interface. Existing signatures and files are preserved. Send an empty object or an optional reason…
- Notifications
  - [[BETA] Send a push announcement to app users (deprecated path)](https://developers.edusign.com/reference/post_notifications-announcements.md): Deprecated: use POST /messages/announcements, which takes the same body and returns the same responses. This path is kept for existing integrations and will be removed once they have migrated; its…
- Classrooms
  - [[BETA] List classrooms](https://developers.edusign.com/reference/get_classrooms.md): Retrieve the classrooms of your school, paginated.
  - [[BETA] Create a new classroom](https://developers.edusign.com/reference/post_classrooms.md): Create a single classroom for your school. The name must be unique within the school.
  - [[BETA] Update a classroom](https://developers.edusign.com/reference/patch_classrooms-id.md): Partial update of a classroom. Only provided fields are modified.  - If a field is set to `null` → its value is reset. - If a field is not provided → partial update, the field is ignored.
  - [[BETA] Delete a classroom](https://developers.edusign.com/reference/delete_classrooms-id.md): Delete a classroom by ID.
  - [[BETA] Update a classroom by external reference ID](https://developers.edusign.com/reference/patch_classrooms-by-reference-id-externalreferenceid.md): Partial update of a classroom by external reference ID. Only provided fields are modified.  - If a field is set to `null` → its value is reset. - If a field is not provided → partial update, the…
  - [[BETA] Delete a classroom by external reference ID](https://developers.edusign.com/reference/delete_classrooms-by-reference-id-externalreferenceid.md): Delete a classroom by external reference ID.
- Connectors
  - [[BETA] List connector logs](https://developers.edusign.com/reference/get_connectors-logs.md): Retrieve the synchronization logs of your school's connector, paginated. Sorted by creation date, oldest first by default.
- Webhooks
  - [[BETA] List all registered webhooks with optional filters](https://developers.edusign.com/reference/get_webhooks.md): List all registered webhooks with optional filters
  - [[BETA] Register a webhook](https://developers.edusign.com/reference/post_webhooks.md): Register a webhook for your school: an event type and the https URL it is delivered to. The same event type can target several URLs; registering the same event type and URL twice returns 409…
  - [[BETA] Update a registered webhook](https://developers.edusign.com/reference/patch_webhooks-id.md): Change the event type, the delivery URL, or both, of a webhook registered for your school; the webhook keeps its id. Only the fields sent are changed, at least one is required. Re-sending the current…
  - [[BETA] Delete a registered webhook](https://developers.edusign.com/reference/delete_webhooks-id.md): Permanently remove a webhook registered for your school: it stops receiving events from the next one on. Deleting an id that does not exist, or no longer exists, returns 404 WEBHOOK_NOT_FOUND.

## API Reference: EDUSIGN PARTNER API
- Schools
  - [Get group data URL](https://developers.edusign.com/reference/getpartnerschoolsschoolgroupurl.md): Retrieves the URL for the group data.
  - [Get settings for a specific school](https://developers.edusign.com/reference/getpartnerschoolsschoolidsettings.md): Retrieves the settings for a specific school.
  - [Update settings for a specific school](https://developers.edusign.com/reference/patchpartnerschoolsschoolidsettings.md): Updates the settings for a specific school.
  - [Get school settings](https://developers.edusign.com/reference/getpartnerschoolssettings.md): Prefer using the /partner/schools/:schoolId/settings route to get settings for a specific school.
  - [Create a new school](https://developers.edusign.com/reference/postpartnerschools.md): Creates a new school with the provided settings.

## Tutorials
- [Get a course's data and attendance sheet PDF Link](https://developers.edusign.com/recipes/get-a-courses-data-and-attendance-sheet-pdf-link.md)
- [How to create a course ?](https://developers.edusign.com/recipes/how-to-create-a-course-1.md)
- [How to create a course without group?](https://developers.edusign.com/recipes/how-to-create-a-course-without-group.md)
- [How to display a dynamic QR-code ?](https://developers.edusign.com/recipes/how-to-display-a-dynamic-qr-code.md)
- [How to secure a webhook received from Edusign ?](https://developers.edusign.com/recipes/how-to-secure-a-webhook-received-from-edusign.md)
- [How to send a document ?](https://developers.edusign.com/recipes/how-to-send-a-document.md)
- [How to send a survey ?](https://developers.edusign.com/recipes/how-to-send-a-survey.md)
- [Archive one-one meeting when professor has signed](https://developers.edusign.com/recipes/recipe-title.md)

## Changelog
- [Summer release note - announcements, surveys & registrations go API-first, MCP & OAuth 2.1 for agentic systems](https://developers.edusign.com/changelog/summer-release-note-announcements-surveys-registrations-go-api-first-mcp-oauth-21-for-agentic-systems.md)
- [Filter, paginate and enrich training results — Full query overhaul for GET /v3/trainings](https://developers.edusign.com/changelog/filter-paginate-and-enrich-training-results-full-query-overhaul-for-get-v3trainings.md)
- [Batch upsert trainings — Create or update up to 1,000 trainings in a single request](https://developers.edusign.com/changelog/batch-upsert-trainings-create-or-update-up-to-1000-trainings-in-a-single-request.md)
- [Batch upsert groups — Create or update up to 1000 groups in a single request](https://developers.edusign.com/changelog/batch-upsert-groups-create-or-update-up-to-1000-groups-in-a-single-request.md)
- [Batch upsert professors — Create or update up to 1,000 professors in a single request](https://developers.edusign.com/changelog/batch-upsert-professors-create-or-update-up-to-1000-professors-in-a-single-request.md)
- [Batch upsert students — Create or update up to 1000 students in a single request](https://developers.edusign.com/changelog/batch-upsert-students-create-or-update-up-to-1000-students-in-a-single-request.md)
- [Get all students - New query param filters to precise your request & pagination](https://developers.edusign.com/changelog/get-all-students-new-query-param-filters-to-precise-your-request.md)
- [Professor signature Timestamp added to "Get all courses" & "Get a course by ID"](https://developers.edusign.com/changelog/professor-signature-timestamp-added-to-get-all-courses-get-a-course-by-id.md)
- [Get all courses - New filters for more accurate results](https://developers.edusign.com/changelog/get-all-courses-new-filters-for-better-results.md)
- [Edit your training registration options from the API](https://developers.edusign.com/changelog/edit-your-training-registration-options-from-the-api.md)