# Dueflow API

> The Dueflow API: read your roster, groups, payments and reimbursements, and write back to them.

- [Dueflow API](https://docs.dueflow.co/introduction.md): Read and write your organization's Dueflow data over HTTPS.
- [Authentication](https://docs.dueflow.co/authentication.md): Bearer tokens, token types, and what happens when your role changes.
- [Scopes and roles](https://docs.dueflow.co/api-reference/scopes.md): Every scope, what it grants, and the role required to hold it.
- [MCP server](https://docs.dueflow.co/mcp-server.md): Use the API from ChatGPT, Claude or any MCP client – with OAuth or a bearer token.
- [Pagination and sync](https://docs.dueflow.co/pagination.md): Cursor pagination and incremental synchronization.
- [Idempotency](https://docs.dueflow.co/idempotency.md): Why every write needs a key, and exactly what a reused key does.
- [Rate limits](https://docs.dueflow.co/rate-limits.md): Per-token buckets, what a request costs, and how to back off.
- [Errors](https://docs.dueflow.co/errors.md): One error envelope, the codes it can carry, and which failures are worth retrying.
- [Sync your roster](https://docs.dueflow.co/guides/sync-your-roster.md): A worked example: pull every member into your own system, then keep it current.
- [List activity log events](https://docs.dueflow.co/api-reference/audit/list-activity-log-events.md): > **Requires scope** `audit:read` · **Minimum role** admin
- [List campaigns](https://docs.dueflow.co/api-reference/fundraising/list-campaigns.md): > **Requires scope** `fundraise:read` · **Minimum role** viewer
- [Retrieve a campaign](https://docs.dueflow.co/api-reference/fundraising/retrieve-a-campaign.md): > **Requires scope** `fundraise:read` · **Minimum role** viewer
- [List donations](https://docs.dueflow.co/api-reference/fundraising/list-donations.md): > **Requires scope** `fundraise:read` · **Minimum role** viewer
- [Retrieve a donation](https://docs.dueflow.co/api-reference/fundraising/retrieve-a-donation.md): > **Requires scope** `fundraise:read` · **Minimum role** viewer
- [List card transactions](https://docs.dueflow.co/api-reference/card-transactions/list-card-transactions.md): > **Requires scope** `cards:read` · **Minimum role** editor
- [Retrieve a card transaction](https://docs.dueflow.co/api-reference/card-transactions/retrieve-a-card-transaction.md): > **Requires scope** `cards:read` · **Minimum role** editor
- [Itemize a card transaction](https://docs.dueflow.co/api-reference/card-transactions/itemize-a-card-transaction.md): > **Requires scope** `cards:write` · **Minimum role** admin
- [List cards](https://docs.dueflow.co/api-reference/cards/list-cards.md): > **Requires scope** `cards:read` · **Minimum role** editor
- [Create a card](https://docs.dueflow.co/api-reference/cards/create-a-card.md): > **Requires scope** `cards:write` · **Minimum role** admin
- [Retrieve a card](https://docs.dueflow.co/api-reference/cards/retrieve-a-card.md): > **Requires scope** `cards:read` · **Minimum role** editor
- [Update a card's limits](https://docs.dueflow.co/api-reference/cards/update-a-cards-limits.md): > **Requires scope** `cards:write` · **Minimum role** admin
- [Cancel a card](https://docs.dueflow.co/api-reference/cards/cancel-a-card.md): > **Requires scope** `cards:write` · **Minimum role** admin
- [Freeze a card](https://docs.dueflow.co/api-reference/cards/freeze-a-card.md): > **Requires scope** `cards:write` · **Minimum role** admin
- [Unfreeze a card](https://docs.dueflow.co/api-reference/cards/unfreeze-a-card.md): > **Requires scope** `cards:write` · **Minimum role** admin
- [List child chapters](https://docs.dueflow.co/api-reference/organization/list-child-chapters.md): > **Requires scope** `chapters:read` · **Minimum role** viewer
- [Retrieve the organization](https://docs.dueflow.co/api-reference/organization/retrieve-the-organization.md): > **Requires scope** `organization:read` · **Minimum role** viewer
- [List a chapter's members](https://docs.dueflow.co/api-reference/members/list-a-chapters-members.md): > **Requires scope** `chapters:read` · `members:read` · **Minimum role** viewer
- [List members](https://docs.dueflow.co/api-reference/members/list-members.md): > **Requires scope** `members:read` · **Minimum role** viewer
- [Create a member](https://docs.dueflow.co/api-reference/members/create-a-member.md): > **Requires scope** `members:write` · **Minimum role** editor
- [Retrieve a member](https://docs.dueflow.co/api-reference/members/retrieve-a-member.md): > **Requires scope** `members:read` · **Minimum role** viewer
- [Update a member](https://docs.dueflow.co/api-reference/members/update-a-member.md): > **Requires scope** `members:write` · **Minimum role** editor
- [List groups](https://docs.dueflow.co/api-reference/groups/list-groups.md): > **Requires scope** `groups:read` · **Minimum role** viewer
- [Create a group](https://docs.dueflow.co/api-reference/groups/create-a-group.md): > **Requires scope** `groups:write` · **Minimum role** editor
- [Retrieve a group](https://docs.dueflow.co/api-reference/groups/retrieve-a-group.md): > **Requires scope** `groups:read` · **Minimum role** viewer
- [Update a group](https://docs.dueflow.co/api-reference/groups/update-a-group.md): > **Requires scope** `groups:write` · **Minimum role** editor
- [Add members to a group](https://docs.dueflow.co/api-reference/groups/add-members-to-a-group.md): > **Requires scope** `groups:write` · **Minimum role** editor
- [Remove a member from a group](https://docs.dueflow.co/api-reference/groups/remove-a-member-from-a-group.md): > **Requires scope** `groups:write` · **Minimum role** editor
- [List payments](https://docs.dueflow.co/api-reference/payments/list-payments.md): > **Requires scope** `payments:read` · **Minimum role** viewer
- [Retrieve a payment](https://docs.dueflow.co/api-reference/payments/retrieve-a-payment.md): > **Requires scope** `payments:read` · **Minimum role** viewer
- [List payouts](https://docs.dueflow.co/api-reference/payouts/list-payouts.md): > **Requires scope** `payouts:read` · **Minimum role** editor
- [Retrieve a payout](https://docs.dueflow.co/api-reference/payouts/retrieve-a-payout.md): > **Requires scope** `payouts:read` · **Minimum role** editor
- [List reimbursements](https://docs.dueflow.co/api-reference/reimbursements/list-reimbursements.md): > **Requires scope** `reimbursements:read` · **Minimum role** viewer
- [Retrieve a reimbursement](https://docs.dueflow.co/api-reference/reimbursements/retrieve-a-reimbursement.md): > **Requires scope** `reimbursements:read` · **Minimum role** viewer
- [Approve or reject a reimbursement](https://docs.dueflow.co/api-reference/reimbursements/approve-or-reject-a-reimbursement.md): > **Requires scope** `reimbursements:write` · **Minimum role** editor
- [List reminders](https://docs.dueflow.co/api-reference/reminders/list-reminders.md): > **Requires scope** `reminders:read` · **Minimum role** viewer
- [Retrieve a reminder](https://docs.dueflow.co/api-reference/reminders/retrieve-a-reminder.md): > **Requires scope** `reminders:read` · **Minimum role** viewer
- [Send a scheduled reminder now](https://docs.dueflow.co/api-reference/reminders/send-a-scheduled-reminder-now.md): > **Requires scope** `reminders:write` · **Minimum role** editor
- [List store listings](https://docs.dueflow.co/api-reference/store/list-store-listings.md): > **Requires scope** `store:read` · **Minimum role** viewer
- [Retrieve a store listing](https://docs.dueflow.co/api-reference/store/retrieve-a-store-listing.md): > **Requires scope** `store:read` · **Minimum role** viewer
- [List store orders](https://docs.dueflow.co/api-reference/store/list-store-orders.md): > **Requires scope** `store:read` · **Minimum role** viewer
- [Retrieve a store order](https://docs.dueflow.co/api-reference/store/retrieve-a-store-order.md): > **Requires scope** `store:read` · **Minimum role** viewer

## OpenAPI Specs

- [openapi](/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.