Improved
Filter, paginate and enrich training results — Full query overhaul for GET /v3/trainings
13 days ago by ReadMe API
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) andlimit; out-of-range pages are detected and reported cleanly - Enrichment flags:
includeStudents,includeProfessors,includeInscriptionOptions— inline related data to avoid extra round-trips - Metadata passthrough:
metadatastored on training records is now returned in responses - External reference IDs on embedded
studentsandprofessorsobjects — essential for cross-system reconciliation
What to expect
- All filter parameters are optional; omitting them returns the full list (subject to pagination)
pageis strictly 1-based; a request beyond the last page returns an explicit out-of-range error rather than an empty silent responseincludeStudents/includeProfessorspopulate thestudentsandprofessorsarrays inline, each exposingexternalReferenceIdandexternalReferenceTypeincludeInscriptionOptionspopulates theinscriptionOptionsarray inline- Response fields
createdAtandupdatedAtare now returned alongsidestartDateTimeandendDateTime
Overview
Endpoint: GET /v3/trainings
Query parameters
| Parameter | Type | Description |
|---|---|---|
trainingIds | string[] | Filter by one or more Edusign internal training IDs. |
trainingExternalReferenceIds | string[] | Filter by one or more external reference IDs. |
trainingName | string | Filter by a string included in the training name. |
trainingStartDateTime | string (ISO 8601) | Return trainings starting at or after this datetime. |
trainingEndDateTime | string (ISO 8601) | Return trainings ending at or before this datetime. |
studentIds | string[] | Return trainings that include any of the given student IDs. |
studentExternalReferenceIds | string[] | Return trainings that include students matching the given external reference IDs. |
professorIds | string[] | Return trainings that include any of the given professor IDs. |
professorExternalReferenceIds | string[] | Return trainings that include professors matching the given external reference IDs. |
tags | string[] | Filter by one or more tags. |
creatorId | string | Filter by the creator's internal user ID. |
isArchived | boolean | When true, return only archived trainings. When false, return only active ones. Omit for all. |
dateUpdated | string (ISO 8601) | Return trainings updated at or after this datetime. |
page | integer | 1-based page index. Returns an error if out of range. |
limit | integer | Number of results per page. |
includeStudents | boolean | When true, populates the students array inline with externalReferenceId and externalReferenceType. |
includeProfessors | boolean | When true, populates the professors array inline with externalReferenceId and externalReferenceType. |
includeInscriptionOptions | boolean | When true, populates the inscriptionOptions array inline. |

