Skip to content
SchulungstoolSchulungstool API

Expanding resources

Some resources, for example the course object or the participation object, have fields that can be expanded into a full object without requiring another request to the API. Without expansion, these fields contain only the ID of the linked object.

To expand fields of a resource, send the query parameter expand with the field names to expand (comma-separated).

Examples:

  • Course object:
    • Expand the instructor field: ?expand=instructor
  • Participation object:
    • Expand the user field: ?expand=user
    • Expand the user and course fields: ?expand=user,course

Which fields are expandable per endpoint is shown by the expand parameter of the respective endpoint in the API reference.