Improved

Filter, paginate and enrich training results — Full query overhaul for GET /v3/trainings

Query GET /v3/trainings with precision: filter, paginate, and enrich results in a single call. The endpoint now accepts a comprehensive set of query parameters designed for ERP and SIS connector use cases.

What's new

  • Identity filters: trainingIds, trainingExternalReferenceIds — look up specific records by Edusign ID or your own reference
  • Search filters: trainingName, trainingStartDateTime, trainingEndDateTime — narrow by name or time window
  • People filters: studentIds, studentExternalReferenceIds, professorIds, professorExternalReferenceIds — return only trainings linked to given students or professors
  • Attribute filters: tags, creatorId, isArchived, dateUpdated — refine by metadata, creator or archive status
  • Pagination: page (1-based) and limit; out-of-range pages are detected and reported cleanly
  • Enrichment flags: includeStudents, includeProfessors, includeInscriptionOptions — inline related data to avoid extra round-trips
  • Metadata passthrough: metadata stored on training records is now returned in responses
  • External reference IDs on embedded students and professors objects — essential for cross-system reconciliation

What to expect

  • All filter parameters are optional; omitting them returns the full list (subject to pagination)
  • page is strictly 1-based; a request beyond the last page returns an explicit out-of-range error rather than an empty silent response
  • includeStudents / includeProfessors populate the students and professors arrays inline, each exposing externalReferenceId and externalReferenceType
  • includeInscriptionOptions populates the inscriptionOptions array inline
  • Response fields createdAt and updatedAt are now returned alongside startDateTime and endDateTime

Overview

Endpoint: GET /v3/trainings

Query parameters

ParameterTypeDescription
trainingIdsstring[]Filter by one or more Edusign internal training IDs.
trainingExternalReferenceIdsstring[]Filter by one or more external reference IDs.
trainingNamestringFilter by a string included in the training name.
trainingStartDateTimestring (ISO 8601)Return trainings starting at or after this datetime.
trainingEndDateTimestring (ISO 8601)Return trainings ending at or before this datetime.
studentIdsstring[]Return trainings that include any of the given student IDs.
studentExternalReferenceIdsstring[]Return trainings that include students matching the given external reference IDs.
professorIdsstring[]Return trainings that include any of the given professor IDs.
professorExternalReferenceIdsstring[]Return trainings that include professors matching the given external reference IDs.
tagsstring[]Filter by one or more tags.
creatorIdstringFilter by the creator's internal user ID.
isArchivedbooleanWhen true, return only archived trainings. When false, return only active ones. Omit for all.
dateUpdatedstring (ISO 8601)Return trainings updated at or after this datetime.
pageinteger1-based page index. Returns an error if out of range.
limitintegerNumber of results per page.
includeStudentsbooleanWhen true, populates the students array inline with externalReferenceId and externalReferenceType.
includeProfessorsbooleanWhen true, populates the professors array inline with externalReferenceId and externalReferenceType.
includeInscriptionOptionsbooleanWhen true, populates the inscriptionOptions array inline.