Recipients
get_recipientsLists the people in a recipient group so you can address a message; set include_virtual=true for modern student or parent groups that contain only virtual accounts.
Instructions
List the people in one recipient group, to address a message. Modern students and parents groups include virtual accounts only with include_virtual=true in recipient_type. On legacy accounts the lookup changes this login's Librus form state. Nothing is sent.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account_alias | Yes | Login alias from list_accounts. | |
| recipient_type | Yes | A group's reference from get_recipient_types. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | ||
| backend | Yes | ||
| context | Yes | ||
| identity | Yes | ||
| pagination | No | ||
| observation | Yes |