Get the organizations a giving report may cover

The giving books are split by organization when the account has two or more active organizations, or when an archived organization owns gifts or batches; while they are not, split is false, organizations is empty and every giving report covers the account as before. While split, each run of the Batch Summary, Combined Contributions, Contribution Range and Lapsed Donor reports covers exactly one organization, named by its organization parameter (a bare id or an { id, name } pair). organizations lists the ones the caller may name: the active organizations their campus lens (the X-Campus-Lens header) reaches where they hold Full Read Contributions at one or more campuses, by id, then the archived organizations that own gifts or batches where they hold Full Read Contributions without any campus limit or campus override narrowing it, by name (an archived organization's giving is read whole, never narrowed by the lens). A run naming any other organization, or a value that names no single organization, is refused: an interactive run fails with an error, and a scheduled run is blocked and its owner told. Without one the run falls back to the only offered active organization, else the default organization when offered, else the first offered active organization; never an archived one. Needs Full Read Contributions.

Required permission: Full Read Contributions

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json