---
canonical_url: "https://docs.composio.dev/toolkits/donately"
markdown_url: "https://docs.composio.dev/toolkits/donately.md"
product: "platform"
version: null
last_updated: null
---

# Donately

Donately is a fundraising platform for managing campaigns, donations, recurring giving, donors, forms, fundraisers, and webhooks.

- **Category:** fundraising
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `DONATELY`
- **Version:** 00000000_00

## Tools

### Get Current Account

**Slug:** `DONATELY_GET_CURRENT_ACCOUNT`

Return the Donately account associated with the connected API token, including its identity, currency, status, and billing plan.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Form

**Slug:** `DONATELY_GET_FORM`

Return a specific Donately donation form and its embedded configuration by form ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `form_id` | string | Yes | Donately form ID beginning with frm_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Person

**Slug:** `DONATELY_GET_PERSON`

Return a specific Donately donor or contact by person ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `person_id` | string | Yes | Donately person ID beginning with per_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Campaigns

**Slug:** `DONATELY_LIST_CAMPAIGNS`

List campaigns in the connected Donately account, optionally filtering by publication state, type, keyword, or fundraiser availability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum campaigns to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue. |
| `status` | string ("draft" | "published" | "archived") | No | Filter by campaign status: draft, published, or archived. |
| `keyword` | string | No | Search campaigns by keyword. |
| `campaign_type` | string | No | Exact value from a campaign's type field; omit to include all campaign types. |
| `has_fundraisers` | boolean | No | Filter to campaigns that do or do not have fundraisers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Donations

**Slug:** `DONATELY_LIST_DONATIONS`

List donation records in the connected account and filter them by status, related donor or fundraising resource, payment type, or other common attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum donations to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `status` | string ("completed" | "pending" | "refunded" | "rejected") | No | Filter by donation status: completed, pending, refunded, or rejected. |
| `keyword` | string | No | Search donation records by keyword. |
| `currency` | string | No | Filter by lowercase currency code, such as usd. |
| `anonymous` | boolean | No | Filter anonymous or identified donations. |
| `person_id` | string | No | Filter by donor person ID beginning with per_. |
| `recurring` | boolean | No | Filter recurring or one-time donations. |
| `campaign_id` | string | No | Filter by campaign ID beginning with cmp_. |
| `donation_type` | string ("cc" | "cash_or_check") | No | Filter by documented donation type: cc or cash_or_check. |
| `fundraiser_id` | string | No | Filter by fundraiser ID beginning with fun_. |
| `amount_in_cents` | integer | No | Filter by exact donation amount in the currency's smallest unit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Forms

**Slug:** `DONATELY_LIST_FORMS`

List donation forms in the connected Donately account, including default-form and form configuration information returned by Donately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum forms to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Fundraisers

**Slug:** `DONATELY_LIST_FUNDRAISERS`

List peer-to-peer fundraisers in the connected Donately account, optionally limited to one campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum fundraisers to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page and pass it back unchanged to continue. |
| `campaign_id` | string | No | Filter by campaign ID (cmp_). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List People

**Slug:** `DONATELY_LIST_PEOPLE`

List donors and contacts in the connected Donately account, optionally searching by keyword.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum people to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |
| `keyword` | string | No | Search donors and contacts by keyword. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Subscriptions

**Slug:** `DONATELY_LIST_SUBSCRIPTIONS`

List recurring donation subscriptions in the connected Donately account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum subscriptions to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Webhooks

**Slug:** `DONATELY_LIST_WEBHOOKS`

List webhook registrations configured for the connected Donately account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum webhooks to return in this page (1-100). |
| `cursor` | string | No | Continuation cursor returned by a previous call; omit for the first page and pass it back unchanged to continue. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |