academyFIVE API icon

academyFIVE API

Interact with academyFIVE API

Actions549

Gkv-pending-messages → List GKV pending messages

AI-generated

Summary

Lists GKV pending messages from the academyFIVE API, optionally filtered and sorted using query parameters. Results are returned as JSON items, with each item paired to its corresponding input item.

Inputs

  • page[number] — Page number to return, starting at 1; defaults to 1.
  • page[size] — Number of records per page; defaults to 50.
  • filter[ids] — Comma-separated GKV pending message IDs to include.
  • filter[messageType] — Comma-separated message type codes to include.
  • filter[message] — Filter by message content; use % as a wildcard.
  • filter[healthInsuranceNumber] — Filter by health insurance number; use % as a wildcard.
  • filter[firstname] — Filter by first name; use % as a wildcard.
  • filter[lastname] — Filter by last name; use % as a wildcard.
  • filter[assignedProfileId] — Filter by the assigned student profile ID.
  • filter[instituteString] — Filter by institute identification string; use % as a wildcard.
  • filter[computedTypeId] — Comma-separated computed message type codes to include.
  • sort — Comma-separated sort fields; prefix a field with a minus sign for descending order.

Output shape

A list of JSON items containing the API response data.

The request runs once per incoming item, and returned items are paired with their input item. If continue-on-fail is enabled, a failed request produces an item with an error field.

Links

Discussion