Tool reference

All 185 tools

87 read and 98 change data, in 22 groups. Each page shows the name to call, the arguments to send and what comes back.

Authentication

Platform sign-in, signup and session management

Tool	What it does
`get_auth_me`	The calling principal, with freshly re-hydrated permissions	Read
`get_auth_me_onboarding`	The first-time tours and popups the signed-in user has already seen	Read
`put_auth_me_onboarding_by_topic`	Record that the signed-in user has seen a first-time tour or popup	Changes data

Users

User management operations

Tool	What it does
`get_users`	List the users of the caller's organizations	Read
`post_users`	Create a user directly, into a named organization	Changes data
`put_users_by_id`	Update a user's profile	Changes data
`delete_users_by_id`	Flag a user as deleted	Changes data
`post_users_by_id_resend_invitation`	Re-send the sign-in invitation email to a user who has not accepted	Changes data
`delete_users_by_id_sessions`	Force-logout a user — end every session they hold	Changes data

Organizations

Organization management operations

Tool	What it does
`get_orgs`	List organizations the caller is entitled to see	Read
`post_orgs`	Create an organization together with its one owner	Changes data
`patch_orgs_bulk`	Apply the same field changes to several organizations	Changes data
`delete_orgs_bulk`	Soft-delete several organizations as one all-or-nothing deletion, or preview it	Changes data
`post_orgs_join`	Request membership of an organization	Changes data
`get_orgs_summary`	Organization counts for the dashboard header, over the orgs the caller may view	Read
`get_orgs_tree`	Get the organization hierarchy the caller may see	Read
`get_orgs_types`	List the organization types the platform recognises	Read
`get_orgs_by_id`	Get one organization	Read
`patch_orgs_by_id`	Update an organization's DAL-backed fields	Changes data
`delete_orgs_by_id`	Soft-delete one organization, cascading, and report what was removed	Changes data
`post_orgs_by_id_approve`	Approve an organization	Changes data
`post_orgs_by_id_connect`	Onboard the organization's Stripe Connect account	Changes data
`get_orgs_by_id_deletion_preview`	What deleting this organization would remove, deactivate and keep — without deleting it	Read
`post_orgs_by_id_suspend`	Suspend an organization	Changes data

Groups

Groups and group membership

Tool	What it does
`get_groups`	List groups, scoped to the caller's organizations	Read
`post_groups`	Create a group inside exactly one organization	Changes data
`get_groups_by_id`	Get one group	Read
`put_groups_by_id`	Update a group, without moving it between organizations	Changes data
`delete_groups_by_id`	Archive (soft-delete) a group	Changes data
`get_groups_by_id_members`	List a group's memberships	Read
`post_groups_by_id_members`	Add a user to a group	Changes data
`delete_groups_by_id_members_by_userid`	Remove a user from a group	Changes data

Roles

Roles and permission assignment

Tool	What it does
`get_roles`	List the roles the caller may view	Read
`post_roles`	Create a role	Changes data
`get_roles_by_id`	Get one role	Read
`put_roles_by_id`	Update a role	Changes data
`delete_roles_by_id`	Archive a role (soft delete)	Changes data
`get_roles_by_id_permissions`	Get a role's permissions, grouped by category	Read
`post_roles_by_id_permissions`	Grant permissions to a role	Changes data
`delete_roles_by_id_permissions`	Revoke permissions from a role	Changes data

Organization Administration

Owner delegation: an organization's roles, groups, members and direct grants, decided by the DAL with the caller's own principal

Tool	What it does
`patch_org_admin_groups_by_groupid`	Rename a group of the organization, or change its description	Changes data
`delete_org_admin_groups_by_groupid`	Delete a group of the organization	Changes data
`post_org_admin_groups_by_groupid_members`	Put a person in a group — an existing account by email, or a new account	Changes data
`delete_org_admin_groups_by_groupid_members_by_userid`	Remove a person from a group of the organization	Changes data
`put_org_admin_groups_by_groupid_roles`	Set exactly which of the organization's roles a group carries	Changes data
`post_org_admin_members_by_userid_permissions`	Grant one of the organization's permissions to one member directly	Changes data
`delete_org_admin_members_by_userid_permissions_by_orgpermissionid`	Revoke a member's direct grant of one of the organization's permissions	Changes data
`patch_org_admin_roles_by_roleid`	Rename an organization role, or set exactly which of its organization's permissions it grants	Changes data
`delete_org_admin_roles_by_roleid`	Delete an organization role	Changes data
`get_org_admin_by_orgid`	What an organization can grant, and what the caller holds there	Read
`get_org_admin_by_orgid_groups`	The organization's groups, their roles and rosters	Read
`post_org_admin_by_orgid_groups`	Create a group in the organization	Changes data
`delete_org_admin_by_orgid_invitations_by_userid`	Take back an invitation the organization sent and the invitee has not answered	Changes data
`post_org_admin_by_orgid_join_requests_by_userid_approve`	Approve a request to join the organization	Changes data
`post_org_admin_by_orgid_join_requests_by_userid_decline`	Decline a request to join the organization	Changes data
`get_org_admin_by_orgid_members`	The organization's members, what each holds there, and where it comes from	Read
`get_org_admin_by_orgid_pending`	The organization's unanswered invitations and undecided join requests	Read
`get_org_admin_by_orgid_roles`	The organization's roles and what each grants	Read
`post_org_admin_by_orgid_roles`	Create a role in the organization, granting some of its permissions	Changes data
`get_org_self_delete_parent_by_parentorgid_requests`	Child organizations' deletion requests awaiting this parent	Read
`get_org_self_delete_by_orgid`	The caller's view of deleting an organization	Read
`post_org_self_delete_by_orgid`	Ask to delete an organization	Changes data
`post_org_self_delete_by_orgid_by_requestid_cancel`	Withdraw a deletion request	Changes data
`post_org_self_delete_by_orgid_by_requestid_confirm`	Confirm deleting an organization with the emailed code	Changes data
`post_org_self_delete_by_orgid_by_requestid_decision`	Approve or decline deleting a child organization	Changes data
`get_ownership_transfers_by_orgid`	The caller's view of an organization's ownership	Read
`post_ownership_transfers_by_orgid`	Start transferring an organization to one of its members	Changes data
`post_ownership_transfers_by_orgid_by_transferid_cancel`	Cancel a pending ownership transfer	Changes data
`post_ownership_transfers_by_orgid_by_transferid_verify`	Confirm the caller's own side of an ownership transfer with their code	Changes data

Vouchers

Voucher inventory, issuance and the claim lifecycle

Tool	What it does
`get_vouchers`	List vouchers, org-scoped unless the caller is platform staff	Read
`get_vouchers_batch_requests`	Voucher-batch requests awaiting a PFF decision	Read
`post_vouchers_batch_requests`	Ask PFF for a batch of vouchers	Changes data
`post_vouchers_batch_requests_by_id_decide`	Approve or deny a voucher-batch request	Changes data
`get_vouchers_batches`	Inventory batches, org-scoped unless the caller is platform staff	Read
`post_vouchers_batches`	Mint a batch of vouchers (voucher-pool and allocation gated)	Changes data
`get_vouchers_batches_capacity`	Who may hold a new voucher batch, and the most vouchers each can be minted	Read
`patch_vouchers_batches_by_id`	Resize a voucher batch through its holder's allocation	Changes data
`delete_vouchers_batches_by_id`	Delete a voucher batch, releasing its vouchers first	Changes data
`post_vouchers_batches_by_id_assign`	Assign an existing batch to an organization	Changes data
`post_vouchers_batches_by_id_print`	Print a physical voucher batch from its id alone	Changes data
`get_vouchers_batches_by_id_print_sheet`	What a print of this physical batch would send now	Read
`get_vouchers_batches_by_id_reprint`	What reprinting this physical batch would do now	Read
`post_vouchers_batches_by_id_reprint`	Reprint every reprintable voucher of a physical batch	Changes data
`post_vouchers_batches_by_id_resend`	Print the same codes again, voiding nothing	Changes data
`get_vouchers_batches_by_id_vouchers`	One batch's vouchers, a page at a time, searchable by code or id	Read
`get_vouchers_claim_stats`	Voucher/claim aggregation for the dashboard	Read
`get_vouchers_pending_claims`	The PFF approval queue — vouchers sitting in CLAIMED	Read
`get_vouchers_procedure_catalog`	Procedure-catalog reference rows and their distinct dimension values	Read
`get_vouchers_scan`	Look a voucher up by its scanned code	Read
`get_vouchers_by_id`	Get one voucher by id, org-scoped	Read
`post_vouchers_by_id_claim`	Claim step 3 — submit the claim	Changes data
`post_vouchers_by_id_expire`	Expire a voucher ahead of its date	Changes data
`post_vouchers_by_id_invalidate`	Invalidate a voucher	Changes data
`post_vouchers_by_id_issue`	Issue a voucher to a beneficiary and email its QR code	Changes data
`post_vouchers_by_id_perform`	Claim step 2 — mark the procedure performed	Changes data
`get_vouchers_by_id_receipt`	A short-lived link to the invoice PDF a claim is paid on	Read
`post_vouchers_by_id_reprint`	Reprint one physical voucher — a new code replaces it, and is printed	Changes data
`post_vouchers_by_id_verify`	Claim step 1 — take a scanned voucher for the caller's clinic	Changes data
`post_vouchers_by_id_void`	Void a voucher	Changes data

Claims

Claim queue and PFF approve-and-credit

Tool	What it does
`get_claims`	The claim queue	Read
`get_claims_auto_approval`	Claim auto-approval — the switch, the trusted clinics and the rules	Read
`put_claims_auto_approval_clinics_by_orgid`	Trust a clinic's claims to the auto-approval rules, or stop trusting them	Changes data
`put_claims_auto_approval_mode`	Switch claim auto-approval OFF, SHADOW or ENFORCE	Changes data
`get_claims_recent`	The 20 most recent claims	Read
`post_claims_by_id_approve`	Approve a claimed voucher and credit the clinic (deferred EFT)	Changes data

Finance

Ledger reads, allocations and payouts

Tool	What it does
`get_allocations`	Every organization's voucher budget, and what the pool has left to give	Read
`post_allocations`	Grant an organization a standing voucher budget	Changes data
`get_allocations_by_orgid_ledger`	One organization's allocation as ledger lines, with the running balance	Read
`get_allocations_by_orgid_lots`	One organization's allocation as lots, oldest first	Read
`post_allocations_by_orgid_revoke`	Take back part of an organization's unspent voucher budget	Changes data
`get_finance_allocations`	The voucher-pool credit for each donation	Read
`get_finance_clawbacks`	The payout clawback review queue (platform staff)	Read
`post_finance_clawbacks`	File a payout clawback — a clinic for a voucher it took, or platform staff	Changes data
`get_finance_clawbacks_voucher`	Look a voucher up by code before filing a clawback of it (platform staff)	Read
`get_finance_clawbacks_by_id`	One payout clawback with its recovery legs (platform staff)	Read
`post_finance_clawbacks_by_id_decide`	Approve or deny a REQUESTED payout clawback (platform staff)	Changes data
`post_finance_clawbacks_by_id_execute`	Send an approved clawback's notice if it has not been, then execute it (platform staff)	Changes data
`put_finance_clawbacks_by_id_fee_liability`	Change who pays processing on a clawback being collected (platform staff)	Changes data
`post_finance_clawbacks_by_id_offsets_by_payouttransactionid_release`	Return an offset whose Stripe transfer failed to the clinic's balance (platform staff)	Changes data
`post_finance_clawbacks_by_id_recoveries`	Record a repayment received outside Stripe (platform staff)	Changes data
`post_finance_clawbacks_by_id_write_off`	Write an approved clawback off (platform staff)	Changes data
`get_finance_donations`	Every live donation, as the finance dashboard's table reads them	Read
`post_finance_eft_onboard`	Make an organization payout-ready	Changes data
`get_finance_ledger_verify`	Verify the ledger journal's hash chain and latest checkpoint (platform staff)	Read
`get_finance_metrics`	Everything /summary reports except currency, plus a six-month revenue trend	Read
`post_finance_payout_accounts_by_orgid_resume_payouts`	Resume a service provider's payouts after a clawback closed without all of its cash (platform staff)	Changes data
`get_finance_payouts`	A service provider's payouts, newest first (platform staff)	Read
`post_finance_payouts_reconcile`	Reconcile settled payouts against Stripe (platform staff)	Changes data
`post_finance_payouts_run`	Settle one organization's accrued balance and pay it out	Changes data
`get_finance_payouts_by_payoutid_vouchers`	The vouchers one payout settled (platform staff)	Read
`post_finance_payouts_by_transactionid_resend_transfer`	Send the Stripe transfer of a settled payout that Stripe never received (platform staff)	Changes data
`get_finance_summary`	Ledger totals for the finance dashboard header	Read
`get_finance_transfers`	Every internal transfer between PFF's two Stripe accounts, newest first, and what operations owes the pool (platform staff)	Read
`post_finance_transfers`	Move PFF's money between its two Stripe accounts (platform staff)	Changes data
`get_payee_reports_by_year`	What Pawsitive Future paid each clinic in a calendar year	Read
`get_payee_reports_year_csv`	The payee report as CSV	Read
`get_payout_accounts_by_orgid`	A service provider's payout account	Read
`get_payout_accounts_by_orgid_annual_statement`	The organization's annual payment statement, as a PDF	Read
`get_payout_accounts_by_orgid_clawbacks`	A service provider's payout clawbacks, and the payouts it may report	Read
`post_payout_accounts_by_orgid_clawbacks_by_clawbackid_payment`	Start repaying one of the organization's clawbacks, by bank account or card	Changes data
`post_payout_accounts_by_orgid_eft_remediation`	Open Stripe's page for documents this app cannot collect	Changes data
`post_payout_accounts_by_orgid_payouts`	Pay out the organization's balance now	Changes data
`post_payout_accounts_by_orgid_tax_details`	Add the full SSN or EIN a payout account was set up without	Changes data

Donations

Checkout sessions and donation reads

Tool	What it does
`get_donations`	List donations across every organization	Read
`post_donations_create_checkout_session`	Create a Stripe Checkout session for a public gift	Changes data
`post_donations_org_checkout_session`	Create a Stripe Checkout session for a gift made on behalf of the caller's organization	Changes data
`get_donations_session_by_id`	Read a Stripe Checkout session for the thank-you page	Read
`post_donations_session_by_id_donor_email`	Correct, once, the email the gift of a Checkout session was recorded under	Changes data
`get_donations_session_by_id_receipt`	Download link for the receipt of the gift a Checkout session paid for	Read
`get_donations_stats`	Platform-wide donation aggregates	Read
`get_donations_by_id`	Fetch one donation by id	Read

Analytics

Aggregations and reporting endpoints

Tool	What it does
`get_analytics_dashboard`	Dashboard KPIs aggregated in the graph	Read
`get_analytics_money_position`	Where the money is — the voucher pool over time, clawbacks, operations transfers and Stripe	Read
`get_analytics_service_provider`	A service provider's voucher intake and payouts received	Read
`get_analytics_timeseries`	Daily donations, allocations and payouts over a range	Read

Approvals

Organization signup approval queue

Tool	What it does
`get_approvals_role_requests`	Role-change request queue (stub)	Read
`get_approvals_signups`	Pending organization signup queue	Read
`post_approvals_signups_by_id_approve`	Approve a pending organization signup	Changes data
`post_approvals_signups_by_id_reject`	Reject a pending organization signup	Changes data
`get_approvals_stats`	Approval queue summary counts	Read
`post_auth_approve`	Approve a pending organization signup by contact email	Changes data

Audit

Platform-staff audit trail

Tool	What it does
`get_audit_logs`	List audit entries, newest first	Read
`get_audit_logs_by_id`	Fetch a single audit entry	Read

Admin

Destructive/operator platform administration

Tool	What it does
`post_admin_stripe_backfill`	Import historical Stripe charges the ledger never saw	Changes data

Impersonation

Support impersonation sessions

Tool	What it does
`get_impersonation_audit_by_sessionid`	Audit trail recorded against one session id	Read
`get_impersonation_users`	List accounts that may be impersonated	Read

Support

Support cases

Tool	What it does
`get_support`	List support cases	Read
`post_support`	Create a support case	Changes data
`get_support_by_id`	Fetch one support case	Read
`patch_support_by_id`	Update a support case, or drive it through a status transition	Changes data
`delete_support_by_id`	Archive a support case (soft delete)	Changes data

Search

Console omnibox

Tool	What it does
`get_search`	Console omnibox - search organizations, users and vouchers in one call	Read

Donor Portal

Donor OTP sign-in and donor-scoped self-service

Tool	What it does
`get_me_certificates`	The donor's thank-you certificates	Read
`get_me_certificates_by_id_download`	Mint a short-lived download URL for one of the donor's certificate PDFs	Read
`get_me_donations`	The donor's own donation history	Read
`get_me_summary`	Lifetime giving totals and the donor's current recurring gift	Read

Public

Unauthenticated endpoints the marketing site calls

Tool	What it does
`get_donations_recent`	Recent completed gifts for the marketing site's homepage feed	Read
`get_impact`	Public headline impact numbers for the marketing site	Read
`get_public_vouchers_by_code_availability`	Public voucher availability by code (the voucher QR's landing page)	Read

Webhooks

Provider callbacks — signature-verified, root-mounted

Tool	What it does
`get_webhooks_health`	Per-receiver signature-verification posture	Read
`post_webhooks_stripe_by_eventid_retry`	Replay a Stripe event through the ledger by id	Changes data

Memberships

Tool	What it does
`get_memberships_invitations`	The signed-in user's own pending invitations	Read
`post_memberships_invitations_by_orgid_accept`	Accept the signed-in user's invitation from an organization	Changes data
`post_memberships_invitations_by_orgid_decline`	Decline the signed-in user's invitation from an organization	Changes data

Notifications

Tool	What it does
`get_notifications`	The signed-in user's actionable notifications	Read