---
title: "API reference"
description: "Every endpoint of the Charitips API, grouped by resource, with its method, its fields, its errors and a request you can copy."
canonical: https://www.charitips.com/docs/api-reference
---

# API reference

> Every endpoint of the Charitips API, grouped by resource, with its method, its fields, its errors and a request you can copy.

### Authentication

- `POST /v1/authentication` [Create a token](https://www.charitips.com/docs/api-reference/create-token.md)
- `POST /v1/authentication/magic-links/users/{userId}` [Create a user magic link](https://www.charitips.com/docs/api-reference/create-user-magic-link.md)
- `POST /v1/authentication/magic-links/donors/{donorId}` [Create a donor magic link](https://www.charitips.com/docs/api-reference/create-donor-magic-link.md)
- `POST /v1/authentication/widget` [Create an admin widget token](https://www.charitips.com/docs/api-reference/create-admin-widget-token.md)
- `POST /v1/authentication/donor/widget` [Create a donor widget token](https://www.charitips.com/docs/api-reference/create-donor-widget-token.md)
- `POST /v1/authentication/donor-platform/widget` [Create a donor platform widget token](https://www.charitips.com/docs/api-reference/create-donor-platform-widget-token.md)
- `POST /v1/authentication/logout/users/{userId}` [Logout a user](https://www.charitips.com/docs/api-reference/logout-user.md)
- `POST /v1/authentication/logout/donors/{donorId}` [Logout a donor](https://www.charitips.com/docs/api-reference/logout-donor.md)

### Charities

- `GET /v1/charities/{charityId}` [Get a charity](https://www.charitips.com/docs/api-reference/get-charity.md)
- `GET /v1/charities` [List charities](https://www.charitips.com/docs/api-reference/list-charities.md)
- `GET /v1/charities/{charityId}/profiles` [Find all profiles](https://www.charitips.com/docs/api-reference/find-all-profiles.md)

### Charities Selections

- `GET /v1/charities-selections` [List charities selections](https://www.charitips.com/docs/api-reference/list-charities-selections.md)
- `POST /v1/charities-selections` [Create a charities selection](https://www.charitips.com/docs/api-reference/create-charities-selection.md)
- `GET /v1/charities-selections/{charitiesSelectionId}` [Get a charities selection](https://www.charitips.com/docs/api-reference/get-charities-selection.md)
- `PATCH /v1/charities-selections/{charitiesSelectionId}` [Update a charities selection](https://www.charitips.com/docs/api-reference/update-charities-selection.md)
- `DELETE /v1/charities-selections/{charitiesSelectionId}` [Delete a charities selection](https://www.charitips.com/docs/api-reference/delete-charities-selection.md)
- `POST /v1/charities-selections/{charitiesSelectionId}/add-charity` [Add a charity](https://www.charitips.com/docs/api-reference/add-charity.md)
- `POST /v1/charities-selections/{charitiesSelectionId}/remove-charity` [Remove a charity](https://www.charitips.com/docs/api-reference/remove-charity.md)

### Charity Profiles

- `GET /v1/charity-profiles` [List charity profiles](https://www.charitips.com/docs/api-reference/list-charity-profiles.md)

### Campaigns

- `GET /v1/campaigns` [List campaigns](https://www.charitips.com/docs/api-reference/list-campaigns.md)
- `POST /v1/campaigns` [Create a campaign](https://www.charitips.com/docs/api-reference/create-campaign.md)
- `POST /v1/campaigns/{campaignId}/activate` [Activate a campaign](https://www.charitips.com/docs/api-reference/activate-campaign.md)
- `POST /v1/campaigns/{campaignId}/close` [Close a campaign](https://www.charitips.com/docs/api-reference/close-campaign.md)
- `GET /v1/campaigns/{campaignId}` [Get a campaign](https://www.charitips.com/docs/api-reference/get-campaign.md)
- `PATCH /v1/campaigns/{campaignId}` [Update a campaign](https://www.charitips.com/docs/api-reference/update-campaign.md)
- `DELETE /v1/campaigns/{campaignId}` [Delete a campaign](https://www.charitips.com/docs/api-reference/delete-campaign.md)
- `GET /v1/campaigns/metrics` [Get all campaigns metrics](https://www.charitips.com/docs/api-reference/get-all-campaigns-metrics.md)
- `GET /v1/campaigns/{campaignId}/metrics` [Get campaign metrics](https://www.charitips.com/docs/api-reference/get-campaign-metrics.md)
- `GET /v1/campaigns/{campaignId}/reports` [Get a campaign report](https://www.charitips.com/docs/api-reference/get-campaign-report.md)
- `PUT /v1/campaigns/{campaignId}/translations` [Add a campaign translation](https://www.charitips.com/docs/api-reference/add-campaign-translation.md)
- `PATCH /v1/campaigns/{campaignId}/translations/{campaignTranslationId}` [Update a campaign translation](https://www.charitips.com/docs/api-reference/update-campaign-translation.md)
- `DELETE /v1/campaigns/{campaignId}/translations/{campaignTranslationId}` [Delete a campaign translation](https://www.charitips.com/docs/api-reference/delete-campaign-translation.md)
- `PUT /v1/campaigns/{campaignId}/reminders` [Update campaign reminders](https://www.charitips.com/docs/api-reference/update-campaign-reminders.md)
- `GET /v1/campaigns/{campaignId}/donation-matching` [Get a donation matching](https://www.charitips.com/docs/api-reference/get-donation-matching.md)
- `PATCH /v1/campaigns/{campaignId}/donation-matching` [Update a donation matching](https://www.charitips.com/docs/api-reference/update-donation-matching.md)

### Donations

- `GET /v1/donations` [List donations](https://www.charitips.com/docs/api-reference/list-donations.md)
- `POST /v1/donations` [Create a donation](https://www.charitips.com/docs/api-reference/create-donation.md)
- `POST /v1/donations/{donationId}/claim` [Claim a donation](https://www.charitips.com/docs/api-reference/claim-donation.md)
- `GET /v1/donations/{donationId}` [Get a donation](https://www.charitips.com/docs/api-reference/get-donation.md)
- `PATCH /v1/donations/{donationId}` [Update a donation](https://www.charitips.com/docs/api-reference/update-donation.md)
- `DELETE /v1/donations/{donationId}` [Delete a donation](https://www.charitips.com/docs/api-reference/delete-donation.md)
- `POST /v1/donations/{donationId}/validate` [Validate a donation](https://www.charitips.com/docs/api-reference/validate-donation.md)
- `POST /v1/donations/{donationId}/fiscal-receipts` [Create a donation fiscal receipt](https://www.charitips.com/docs/api-reference/create-donation-fiscal-receipt.md)
- `GET /v1/donations/{donationId}/fiscal-receipt` [Get a donation fiscal receipt](https://www.charitips.com/docs/api-reference/get-donation-fiscal-receipt.md)

### Recurring Donations

- `GET /v1/recurring-donations` [List recurring donations](https://www.charitips.com/docs/api-reference/list-recurring-donations.md)
- `POST /v1/recurring-donations` [Create a recurring donation](https://www.charitips.com/docs/api-reference/create-recurring-donation.md)
- `POST /v1/recurring-donations/{recurringDonationId}/claim` [Claim a recurring donation](https://www.charitips.com/docs/api-reference/claim-recurring-donation.md)
- `GET /v1/recurring-donations/{recurringDonationId}` [Get a recurring donation](https://www.charitips.com/docs/api-reference/get-recurring-donation.md)
- `PATCH /v1/recurring-donations/{recurringDonationId}` [Update a recurring donation](https://www.charitips.com/docs/api-reference/update-recurring-donation.md)
- `POST /v1/recurring-donations/{recurringDonationId}/cancel` [Cancel a recurring donation](https://www.charitips.com/docs/api-reference/cancel-recurring-donation.md)
- `POST /v1/recurring-donations/{recurringDonationId}/pause` [Pause a recurring donation](https://www.charitips.com/docs/api-reference/pause-recurring-donation.md)
- `POST /v1/recurring-donations/{recurringDonationId}/resume` [Resume a recurring donation](https://www.charitips.com/docs/api-reference/resume-recurring-donation.md)

### Votes

- `GET /v1/votes` [List votes](https://www.charitips.com/docs/api-reference/list-votes.md)
- `POST /v1/votes` [Create a vote](https://www.charitips.com/docs/api-reference/create-vote.md)
- `POST /v1/votes/{voteId}/cast` [Cast a vote](https://www.charitips.com/docs/api-reference/cast-vote.md)
- `GET /v1/votes/{voteId}` [Get a vote](https://www.charitips.com/docs/api-reference/get-vote.md)
- `PATCH /v1/votes/{voteId}` [Update a vote](https://www.charitips.com/docs/api-reference/update-vote.md)
- `DELETE /v1/votes/{voteId}` [Delete a vote](https://www.charitips.com/docs/api-reference/delete-vote.md)
- `POST /v1/votes/{voteId}/validate` [Validate a vote](https://www.charitips.com/docs/api-reference/validate-vote.md)

### Donors

- `GET /v1/donors/{donorId}/fiscal-receipts` [Find donor fiscal receipts](https://www.charitips.com/docs/api-reference/find-donor-fiscal-receipts.md)
- `GET /v1/donors/{donorId}/payment-methods` [Find donor payment methods](https://www.charitips.com/docs/api-reference/find-donor-payment-methods.md)
- `GET /v1/donors` [List donors](https://www.charitips.com/docs/api-reference/list-donors.md)
- `POST /v1/donors` [Create a donor](https://www.charitips.com/docs/api-reference/create-donor.md)
- `GET /v1/donors/{donorId}` [Get a donor](https://www.charitips.com/docs/api-reference/get-donor.md)
- `PATCH /v1/donors/{donorId}` [Update a donor](https://www.charitips.com/docs/api-reference/update-donor.md)

### Webhooks

- `GET /v1/webhooks` [List webhooks](https://www.charitips.com/docs/api-reference/list-webhooks.md)
- `POST /v1/webhooks` [Create a webhook](https://www.charitips.com/docs/api-reference/create-webhook.md)
- `GET /v1/webhooks/logs` [Search logs](https://www.charitips.com/docs/api-reference/search-logs.md)
- `GET /v1/webhooks/{webhookId}` [Get a webhook](https://www.charitips.com/docs/api-reference/get-webhook.md)
- `DELETE /v1/webhooks/{webhookId}` [Delete a webhook](https://www.charitips.com/docs/api-reference/delete-webhook.md)

### Fiscal Receipts

- `GET /v1/fiscal-receipts` [List fiscal receipts](https://www.charitips.com/docs/api-reference/list-fiscal-receipts.md)
- `GET /v1/fiscal-receipts/{fiscalReceiptId}` [Get a fiscal receipt](https://www.charitips.com/docs/api-reference/get-fiscal-receipt.md)
- `GET /v1/fiscal-receipts/{fiscalReceiptId}/download-url` [Generate a fiscal receipt download url](https://www.charitips.com/docs/api-reference/generate-fiscal-receipt-download-url.md)
- `POST /v1/fiscal-receipts/bulk-download` [Generate a fiscal receipts bulk download url](https://www.charitips.com/docs/api-reference/generate-fiscal-receipts-bulk-download-url.md)
- `GET /v1/fiscal-receipts/{fiscalReceiptId}/donations` [Get fiscal receipt donations](https://www.charitips.com/docs/api-reference/get-fiscal-receipt-donations.md)

### Invoices

- `GET /v1/invoices` [List invoices](https://www.charitips.com/docs/api-reference/list-invoices.md)
- `GET /v1/invoices/{invoiceId}` [Get an invoice](https://www.charitips.com/docs/api-reference/get-invoice.md)
- `GET /v1/invoices/{invoiceId}/download-url` [Generate an invoice download url](https://www.charitips.com/docs/api-reference/generate-invoice-download-url.md)
- `POST /v1/invoices/bulk-download` [Generate an invoices bulk download url](https://www.charitips.com/docs/api-reference/generate-invoices-bulk-download-url.md)

### Billing

- `GET /v1/billing/payment-details` [Get payment details](https://www.charitips.com/docs/api-reference/get-payment-details.md)

### Files

- `GET /v1/files/file-generation-requests/{fileGenerationRequestId}` [Get a file](https://www.charitips.com/docs/api-reference/get-file.md)
- `POST /v1/files/file-generation-requests` [Create a file generation request](https://www.charitips.com/docs/api-reference/create-file-generation-request.md)
- `GET /v1/files/file-generation-requests/{fileGenerationRequestId}/download-url` [Generate a file generation request download url](https://www.charitips.com/docs/api-reference/generate-file-generation-request-download-url.md)

### Sites

- `GET /v1/sites` [List sites](https://www.charitips.com/docs/api-reference/list-sites.md)
- `POST /v1/sites` [Create a site](https://www.charitips.com/docs/api-reference/create-site.md)
- `GET /v1/sites/{siteId}` [Get a site](https://www.charitips.com/docs/api-reference/get-site.md)
- `PATCH /v1/sites/{siteId}` [Update a site](https://www.charitips.com/docs/api-reference/update-site.md)
- `GET /v1/sites/{siteId}/status` [Get site status](https://www.charitips.com/docs/api-reference/get-site-status.md)

### Accounts

- `GET /v1/accounts` [List accounts](https://www.charitips.com/docs/api-reference/list-accounts.md)
- `GET /v1/accounts/{accountId}` [Get an account](https://www.charitips.com/docs/api-reference/get-account.md)
- `PATCH /v1/accounts/{accountId}` [Update an account](https://www.charitips.com/docs/api-reference/update-account.md)
- `POST /v1/accounts/{accountId}/invite` [Create an invitation](https://www.charitips.com/docs/api-reference/create-invitation.md)
- `GET /v1/accounts/{accountId}/child-accounts` [List child accounts](https://www.charitips.com/docs/api-reference/list-child-accounts.md)
- `POST /v1/accounts/{accountId}/child-accounts` [Create a child account](https://www.charitips.com/docs/api-reference/create-child-account.md)
- `GET /v1/accounts/{accountId}/reports` [List account reports](https://www.charitips.com/docs/api-reference/list-account-reports.md)
- `POST /v1/accounts/{accountId}/billing-link` [Create a shareable billing link](https://www.charitips.com/docs/api-reference/create-shareable-billing-link.md)
- `GET /v1/accounts/{accountId}/payment-methods` [Get payment methods](https://www.charitips.com/docs/api-reference/get-payment-methods.md)
- `POST /v1/accounts/{accountId}/donor-platform` [Enable donor platform](https://www.charitips.com/docs/api-reference/enable-donor-platform.md)
- `DELETE /v1/accounts/{accountId}/donor-platform` [Disable a donor platform](https://www.charitips.com/docs/api-reference/disable-donor-platform.md)
- `GET /v1/accounts/{accountId}/entitlements` [Get entitlements](https://www.charitips.com/docs/api-reference/get-entitlements.md)

### Users

- `GET /v1/users` [List users](https://www.charitips.com/docs/api-reference/list-users.md)
- `POST /v1/users` [Create a user](https://www.charitips.com/docs/api-reference/create-user.md)
- `GET /v1/users/{userId}` [Get a user](https://www.charitips.com/docs/api-reference/get-user.md)
- `PATCH /v1/users/{userId}` [Update a user](https://www.charitips.com/docs/api-reference/update-user.md)
- `DELETE /v1/users/{userId}` [Delete a user](https://www.charitips.com/docs/api-reference/delete-user.md)

### UserInvitations

- `GET /v1/user-invitations` [List user invitations](https://www.charitips.com/docs/api-reference/list-user-invitations.md)
- `PATCH /v1/user-invitations/{userInvitationId}` [Update a user invitation](https://www.charitips.com/docs/api-reference/update-user-invitation.md)
- `DELETE /v1/user-invitations/{userInvitationId}` [Delete a user invitation](https://www.charitips.com/docs/api-reference/delete-user-invitation.md)

### Calendar Events

- `GET /v1/calendar-event-instances` [List calendar event instances](https://www.charitips.com/docs/api-reference/list-calendar-event-instances.md)
- `GET /v1/calendar-event-instances/{calendarEventInstanceId}` [Get a calendar event instance](https://www.charitips.com/docs/api-reference/get-calendar-event-instance.md)

### Campaign Templates

- `GET /v1/campaign-templates` [List campaign templates](https://www.charitips.com/docs/api-reference/list-campaign-templates.md)
- `GET /v1/campaign-templates/{campaignTemplateId}` [Get a campaign template](https://www.charitips.com/docs/api-reference/get-campaign-template.md)

### Card Designs

- `GET /v1/card-designs` [List card designs](https://www.charitips.com/docs/api-reference/list-card-designs.md)