API Reference
  1. EduSign API Next
  2. Courses

[BETA] Search courses with filters in the request body

post
https://ext.edusign.fr/v3/courses:search

Retrieve all the courses of your school (both archived and not archived courses).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number
Defaults to 1

1-based page number for pagination. Defaults to 1.

number
Defaults to 100

Number of results per page (max 100). Defaults to 100.

groupIds
array of strings

Filter by group IDs (1 to 1000 values): courses attached to at least one of these groups. Unknown IDs are silently omitted.

groupIds
studentIds
array of strings

Filter by enrolled student IDs (1 to 1000 values): courses where at least one of these students is enrolled. Unknown IDs are silently omitted.

studentIds
professorIds
array of strings

Filter by professor IDs (1 to 1000 values): courses where at least one of these professors is assigned, co-teachers included. Unknown IDs are silently omitted.

professorIds
trainingIds
array of strings

Filter by training IDs (1 to 1000 values): courses belonging to one of these trainings. Unknown IDs are silently omitted.

trainingIds
date-time

Returns the courses starting at or after this instant. ISO 8601 date-time with a time zone. Combined with courseEndDateTime, returns the courses that start and end between the two instants.

date-time

Returns the courses ending at or before this instant. ISO 8601 date-time with a time zone. Combined with courseStartDateTime, returns the courses that start and end between the two instants.

boolean

true: archived courses only. false: active courses only. Omit for both.

boolean

true: courses whose absences were sent. false: courses whose absences were not sent. Omit for both.

boolean

true: at least one professor assigned to the course has not signed. false: no professor signature is missing (courses without any professor included). Omit for every course.

string

Filter courses based on the classroom.

string

Filter courses based on the creator ID.

string

Partial match on the course name.

string
enum
Defaults to createdAt

Field to sort by: createdAt (creation date), start or end (course dates). Defaults to createdAt. Ties are broken on the course ID, so pages never skip or repeat a course.

Allowed:
string
enum
Defaults to desc

Sort direction. Defaults to desc (newest first).

Allowed:
boolean
Defaults to false

Include students in the response.

boolean
Defaults to false

Include teachers in the response.

boolean
Defaults to false

Include survey templates in the response.

boolean
Defaults to false

Include training data in the response.

Responses

Updated about 2 hours ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 hours ago

Did this page help you?