[BETA] Search trainings with filters in the request body

post

https://ext.edusign.fr/v3/trainings/search

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) are not subject to URL size limits. Non-matching IDs are silently omitted. An empty body returns the unfiltered first page.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

page

number

Defaults to 1

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

limit

number

Defaults to 100

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

trainingIds

array of strings

Filter by internal Edusign training IDs (max 1000). Non-matching IDs are silently omitted.

trainingIds

trainingExternalReferenceIds

array of strings

Filter by external reference IDs (max 1000). Non-matching IDs are silently omitted.

trainingExternalReferenceIds

trainingName

string

Case-insensitive partial match on the training name.

trainingStartDateTime

string

ISO 8601 — keep trainings whose time window overlaps on/after this datetime.

trainingEndDateTime

string

ISO 8601 — keep trainings whose time window overlaps on/before this datetime.

studentIds

array of strings

Filter by enrolled student IDs (at least one match).

studentIds

studentExternalReferenceIds

array of strings

Filter by enrolled student external reference IDs (at least one match).

studentExternalReferenceIds

professorIds

array of strings

Filter by assigned professor IDs (at least one match).

professorIds

professorExternalReferenceIds

array of strings

Filter by assigned professor external reference IDs (at least one match).

professorExternalReferenceIds

tags

creatorId

array of strings

Filter by creator IDs.

creatorId

isArchived

boolean

Filter by archived status. Omitted = all; true = archived only; false = active only.

dateUpdated

array of strings

Inclusive [startDate, endDate] ISO 8601 range on the last updated date.

dateUpdated

includeStudents

boolean

Defaults to false

When true, include a students[] array on each training.

includeProfessors

boolean

Defaults to false

When true, include a professors[] array on each training.

includeInscriptionOptions

boolean

Defaults to false

When true, include inscriptionOptions on each training.

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

401Unauthorized

404Not Found

500Internal Server Error