openapi: 3.2.0
info:
title: GoFundMe Pro Annual Summary API
description: "<h1>GoFundMe Pro API</h1>\n<p>Welcome to the GoFundMe Pro API (2.0.0), a powerful toolset that empowers innovative and creative minds to engineer the world for good. This documentation walks through the API’s latest endpoints.</p>\n<p>GoFundMe Pro APIs are crafted around REST and the REST architectural style to provide developers with a stateless and language-agnostic interface. The GoFundMe Pro API leverages HTTP verbs and response codes, OAuth2 authentication, and resource-oriented URLs.</p>\n<p>Currently, the GoFundMe Pro API only supports JSON. All POST/PUT requests required a valid JSON object for the request body.</p>\n<h2>Errors</h2>\n<p>The GoFundMe Pro API leverages standard HTTP response status codes for it’s error responses. Error codes are:</p>\n<p><br /></p>\n<table border='1'>\n<tr>\n<th width='100px'>Error Code</th>\n<th>Meaning</th>\n</tr>\n<tr>\n<td>400</td>\n<td>Bad Request: The request was malformed or provided incorrect/incomplete/conflicting parameters. Check the response for more detailed messaging about why the request was incorrect. Do not repeat request.</td>\n</tr>\n<tr>\n<td>401</td>\n<td>Unauthorized: The API does not recognize the request as authorized. API access token may be missing or invalid.</td>\n</tr>\n<tr>\n<td>403</td>\n<td>Forbidden: The API recognizes the authorized API user, but the API user does not have correct permissions to satisfy the request.</td>\n</tr>\n<tr>\n<td>404</td>\n<td>Not Found: The resource requested does not exist or was not found.</td>\n</tr>\n<tr>\n<td>405</td>\n<td>Method Not Allowed: Some REST endpoints only accept a subset of valid REST HTTP verbs. This error is sent when an unsupported verb is requested.</td>\n</tr>\n<tr>\n<td>429</td>\n<td>Too Many Requests: The rate limit has been exceeded. See the <a href=\"#rate-limiting\">Rate Limiting</a> section for details on rate limits and response headers.</td>\n</tr>\n<tr>\n<td>500</td>\n<td>Error: The request was valid, but something failed on the server. Additional messages may be available.</td>\n</tr>\n<tr>\n<td>503</td>\n<td>Service Unavailable: The service is temporarily unavailable.</td>\n</tr>\n</table>\n<h2>Requests</h2>\n<h3>Authenticating Requests</h3>\n<p>Most API requests will need to be signed with an Access Token.</p>\n<p>Refer to the <a href=\"https://developers.gofundme.com/pro/overview/authentication\" target=\"_blank\" rel=\"noopener noreferrer\">Resource Documentation</a> for the specific call you are making to see if an access token is required for your request. See <a href=\"https://developers.gofundme.com/pro/tutorials/samples\" target=\"_blank\" rel=\"noopener noreferrer\">this page</a> for a demonstration of usage through a sample app. \n<h3>Filters</h3>\n<p>We can filter a collection based on a set of input parameters. To do so, we can modify the query string using the parameters listed below.</p>\n\n<table border='1'>\n<tr>\n<th>Parameter</th>\n<th>Type</th>\n<th>Default</th>\n<th>Description</th>\n</tr>\n\n<tr>\n<td>with</td>\n<td>string</td>\n<td>N/A</td>\n<td>This allows you to include nested related resource. For example, you could request a campaign along with the organization it belongs to and the designation it was allocated to. In this case, <code>with=organization,designation.</code></td>\n</tr>\n\n<tr>\n<td>per_page</td>\n<td>integer</td>\n<td>20</td>\n<td>Set the total number of resources returned per page (Maximum: 100).</td>\n</tr>\n\n<tr>\n<td>page</td>\n<td>integer</td>\n<td>1</td>\n<td>Page to return.</td>\n</tr>\n\n<tr>\n<td>sort</td>\n<td>string</td>\n<td>Depends on endpoint</td>\n<td>\nOrder the resources depending upon their attributes. Examples:\n<ul>\n<li><strong>created_at</strong>: oldest resource will come first</li>\n<li><strong>created_at:desc</strong>: newest resource will come first</li>\n<li><strong>last_name:asc,first_name:asc</strong>: order resources by last_name in alphabetical order. If same last_name, order by first_name in alphabetical order.</li>\n</ul>\n</td>\n</tr>\n\n<tr>\n<td>fields</td>\n<td>string</td>\n<td>Depends on endpoint</td>\n<td>List of resources attributes separated with comma. Narrow the list of attributes returned for each resource.</td>\n</tr>\n\n<tr>\n<td>filter</td>\n<td>string</td>\n<td>NULL</td>\n<td>\nAllow to filter the list of resources returned. Format is: <code>{association}.{attribute1}{operand}{value}</code> where: <ul>\n<li>association is the association if this is a nested filter (optional)</li>\n<li>operand is one of the following: <code><=, >=, <>, !=, =, <, or ></code>. Operand must be url encoded. (Note: if you are filtering on a boolean value, <code>true</code> can be expressed with <code>true</code> or <code>1</code>. Additionally, false can be expressed with <code>false</code> or <code>0</code>).</li>\n<li>If filtering on an association, ensure you include the nested resource using the ‘with’ parameter. with | string | NULL | This allows you to include a nested related resource. For example, you could request a collection of campaigns along with the organization they belong to and the designation they were allocated to. In this case, <code>with=organization,designation</code>.</li>\n</ul>\n</td>\n</tr>\n</table>\n\n<p>When filtering, the operand should be one of the following:</p>\n<p><code><=, >=, <>, !=, =, <, or ></code>. Operand must be url encoded. (Note: if you are filtering on a boolean value, <code>true</code> can be expressed with <code>true</code> or <code>1</code>. Additionally, <code>false</code> can be expressed with <code>false</code> or <code>0</code>).</p>\n<p>If filtering on an association, ensure you include the nested resource using the ‘with’ parameter. This allows you to include a nested related resource. For example, you could request a collection of campaigns along with the organization they belong to and the designation they were allocated to. In this case, <code>with=organization,designation</code>.</p>\n<p>Refer to the sample documentation for the specific call you are making to see which related resource can be fetched.</p>\n\n<h3>Date and Time Filtering</h3>\n<p>Unless otherwise noted, all Datetime attributes in API responses will be returned in an ISO8601 compliant format:</p>\n<><code>YYYY-MM-DDTHH:mm:ss.sssZ</code> (e.g. <code>2024-10-05T14:48:00.000Z</code>).</p>\n<h2 id=\"rate-limiting\">Rate Limiting</h2>\n<p>The GoFundMe Pro API implements rate limiting to ensure fair usage and maintain service quality for all users. Rate limits are applied on a per-application and per-user basis.</p>\n<h3>When Rate Limiting Applies</h3>\n<p>Rate limiting is applied to requests that meet the following conditions:</p>\n<ul>\n<li>The API application is <strong>not internal</strong> (external/third-party applications)</li>\n<li>The API application is associated to an Organization</li>\n</ul>\n<p>Internal applications are not subject to rate limiting.</p>\n<h3>Rate Limit Details</h3>\n<p>By default, the rate limit is:</p>\n<ul>\n<li><strong>1800 requests per minute</strong> per application</li>\n</ul>\n<p>Rate limits may be adjusted dynamically via flags for specific applications or users.</p>\n<h3>Rate Limit Headers</h3>\n<p>All API responses include the following headers to help you track your rate limit status:</p>\n<table border='1'>\n<tr>\n<th width='200px'>Header</th>\n<th>Description</th>\n</tr>\n<tr>\n<td><code>X-RateLimit-Limit</code></td>\n<td>The maximum number of requests allowed in the current time window</td>\n</tr>\n<tr>\n<td><code>X-RateLimit-Remaining</code></td>\n<td>The number of requests remaining in the current time window</td>\n</tr>\n<tr>\n<td><code>X-RateLimit-Reset</code></td>\n<td>Unix timestamp indicating when the rate limit window resets (only included when limit is exceeded)</td>\n</tr>\n<tr>\n<td><code>Retry-After</code></td>\n<td>Number of seconds to wait before retrying (only included in 429 responses)</td>\n</tr>\n</table>\n<h3>Handling Rate Limit Errors</h3>\n<p>When you exceed the rate limit, the API will return a <code>429 Too Many Requests</code> response with the following structure:</p>\n<pre><code>{\n \"message\": \"Too Many Attempts.\",\n \"retry_after\": 42\n}</code></pre>\n<p>The response will include the <code>Retry-After</code> header indicating how many seconds you should wait before making another request.</p>\n<h3>Best Practices</h3>\n<ul>\n<li>Monitor the <code>X-RateLimit-Remaining</code> header to track your usage</li>\n<li>Implement exponential backoff when you receive a 429 response</li>\n<li>Respect the <code>Retry-After</code> header value before retrying</li>\n<li>Cache responses when possible to reduce API calls</li>\n<li>Batch operations when the API supports it</li>\n</ul>"
version: 2.0.0
servers:
- url: https://pro.gofundme.com/api/2.0
security:
- OAuth2Application: []
- OAuth2Member: []
tags:
- name: Annual Summary
description: Annual Summary
paths:
/organizations/{organization_id}/annual-summary-reports/{year}:
get:
tags:
- Annual Summary
summary: Get Organization ASR Batch for Year
description: Get the ASR batch for an organization for a specific year. Returns the single batch or 404 if none exists.
operationId: getOrganizationAsrBatch
parameters:
- name: organization_id
in: path
description: The specified Organization ID
required: true
schema:
type: integer
example: 1
- name: year
in: path
description: The report year
required: true
schema:
type: integer
example: 2024
- name: status
in: query
description: Filter by batch status
required: false
schema:
type: string
enum:
- pending
- processing
- generating
- completed
- failed
example: completed
- name: limit
in: query
description: Number of results per page
required: false
schema:
type: integer
maximum: 100
minimum: 1
example: 10
responses:
'200':
description: Batch information
content:
application/json:
schema:
properties:
organization_id:
type: integer
example: 1
report_year:
type: integer
example: 2024
status:
type: string
example: completed
total_count:
type: integer
example: 1000
completed_count:
type: integer
example: 1000
failed_count:
type: integer
example: 0
progress_percentage:
type: integer
example: 100
is_complete:
type: boolean
example: true
is_processing:
type: boolean
example: false
started_at:
type:
- string
- 'null'
example: '2024-10-06T12:00:00+00:00'
completed_at:
type:
- string
- 'null'
example: '2024-10-06T12:30:00+00:00'
scheduled_at:
type:
- string
- 'null'
example: '2024-10-06T14:00:00+00:00'
audience:
description: Audience segmentation for the batch
properties:
offline:
type: boolean
example: true
one_time:
type: boolean
example: true
recurring:
type: boolean
example: true
type: object
created_at:
type: string
example: '2024-10-06T11:55:00+00:00'
updated_at:
type: string
example: '2024-10-06T12:30:00+00:00'
type: object
'404':
description: No batch found for this year
content:
application/json:
schema:
properties:
error:
type: string
example: No batch found for this year
message:
type: string
example: No ASR batch exists for 2024. Use POST to create one.
type: object
'403':
description: Requester is not authorized to perform action
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
post:
tags:
- Annual Summary
summary: Generate Annual Summary Reports for Organization (Batch)
description: Generate ASR PDFs for all supporters in an organization who made transactions in the specified year. This is an asynchronous operation.
operationId: generateOrganizationAsrBatch
parameters:
- name: organization_id
in: path
description: The specified Organization ID
required: true
schema:
type: integer
example: 1
- name: year
in: path
description: The report year
required: true
schema:
type: integer
example: 2024
requestBody:
content:
application/json:
schema:
properties:
start_date:
description: Start date for the report (optional, defaults to January 1st of report_year)
type: string
format: date
example: '2024-01-01'
end_date:
description: End date for the report (optional, defaults to December 31st of report_year)
type: string
format: date
example: '2024-12-31'
type: object
responses:
'202':
description: Batch generation started
content:
application/json:
schema:
properties:
organization_id:
description: Organization ID
type: integer
example: 1
report_year:
description: Report year
type: integer
example: 2024
status:
description: Current batch status
type: string
example: pending
message:
type: string
example: Batch generation started.
type: object
'403':
description: Requester is not authorized to perform action
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Organization not found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
'422':
description: Validation error
content:
application/json:
schema:
properties:
error:
type: string
example: Validation failed
errors:
type: object
example:
report_year:
- The report year field is required.
type: object
/organizations/{organization_id}/annual-summary-reports/{year}/supporters/{supporter_id}/download:
get:
tags:
- Annual Summary
summary: Download PDF from Batch ASR Generation
description: Get a presigned download URL for a supporter's PDF from a completed batch
operationId: downloadBatchAsrPdf
parameters:
- name: organization_id
in: path
description: The specified Organization ID
required: true
schema:
type: integer
example: 1
- name: year
in: path
description: The report year
required: true
schema:
type: integer
example: 2024
- name: supporter_id
in: path
description: The specified Supporter ID
required: true
schema:
type: integer
example: 7
responses:
'200':
description: Presigned download URL
content:
application/json:
schema:
properties:
download_url:
description: S3 presigned URL for file download
type: string
example: https://s3.amazonaws.com/bucket/file.pdf?presigned-params
filename:
description: Suggested filename
type: string
example: GivingSummary_JohnDoe_2024.pdf
expires_at:
description: ISO 8601 timestamp when the presigned URL expires
type: string
example: '2024-10-08T12:00:00+00:00'
content_type:
description: MIME type
type: string
example: application/pdf
type: object
'400':
description: Batch is not yet completed
content:
application/json:
schema:
properties:
error:
type: string
example: Batch is not yet completed
status:
type: string
example: generating
type: object
'403':
description: Requester is not authorized to perform action
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Batch or supporter not found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
/organizations/{organization_id}/annual-summary-reports/{year}/schedule:
put:
tags:
- Annual Summary
summary: Update ASR Batch Schedule and/or Audience
description: Update the scheduled delivery time and/or audience filters for an ASR batch. Both parameters are optional - you can update schedule only, audience only, or both together. The batch must be in 'scheduled' or 'pending' status. Changes are synced to the legacy MongoDB Message for compatibility.
operationId: updateOrganizationAsrBatchSchedule
parameters:
- name: organization_id
in: path
description: The specified Organization ID
required: true
schema:
type: integer
example: 1
- name: year
in: path
description: The report year
required: true
schema:
type: integer
example: 2024
requestBody:
content:
application/json:
schema:
properties:
scheduled_at:
description: When to execute the batch (optional, must be in the future)
type: string
format: date-time
example: '2024-12-31T23:59:59Z'
audience:
description: Audience filters to determine which supporters receive reports (optional). At least one type must be enabled if provided.
properties:
offline:
description: Include supporters with offline donations
type: boolean
example: true
one_time:
description: Include supporters with one-time donations
type: boolean
example: true
recurring:
description: Include supporters with recurring donations
type: boolean
example: true
type: object
type: object
responses:
'200':
description: Batch updated successfully
content:
application/json:
schema:
properties:
organization_id:
type: integer
example: 1
report_year:
type: integer
example: 2024
status:
type: string
example: scheduled
scheduled_at:
type:
- string
- 'null'
example: '2024-12-31T23:59:59+00:00'
audience:
properties:
offline:
type: boolean
example: true
one_time:
type: boolean
example: true
recurring:
type: boolean
example: true
type: object
message:
type: string
example: Batch updated successfully.
type: object
'404':
description: Batch not found
content:
application/json:
schema:
properties:
error:
type: string
example: Batch not found
type: object
'422':
description: Validation error or cannot update batch in current status
content:
application/json:
schema:
oneOf:
- properties:
error:
type: string
example: Validation failed
errors:
type: object
example:
scheduled_at:
- The scheduled at must be a date after now.
audience:
- At least one audience type must be enabled (offline, one_time, or recurring).
type: object
- properties:
error:
type: string
example: Cannot update batch
message:
type: string
example: Batch is currently processing and cannot be updated
type: object
'403':
description: Requester is not authorized to perform action
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
/organizations/{organization_id}/supporters/{supporter_id}/annual-summary:
post:
tags:
- Annual Summary
summary: Send Annual Summary Email to Supporter (Admin)
description: Send an annual summary email to a specific supporter. This is an admin-initiated action that does not require a bulk batch send.
operationId: sendSupporterAnnualSummaryEmail
parameters:
- name: organization_id
in: path
description: The specified Organization ID
required: true
schema:
type: integer
example: 1
- name: supporter_id
in: path
description: The specified Supporter ID
required: true
schema:
type: integer
example: 5827
requestBody:
required: true
content:
application/json:
schema:
required:
- report_year
properties:
report_year:
description: Four digit year for which the summary is being requested
type: integer
example: 2025
email:
description: Optional email address to send the summary to (defaults to supporter's email)
type: string
example: donor@example.com
type: object
responses:
'200':
description: Success
content:
application/json:
schema:
properties:
success:
type: boolean
example: true
message:
type: string
example: Annual summary email queued for delivery
type: object
'403':
description: Requester is not authorized to perform action
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Supporter not found or does not belong to organization
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
'422':
description: Validation error
content:
application/json:
schema:
properties:
error:
type: string
example: Validation failed
errors:
type: object
type: object
security:
- OAuth2Member: []
/supporters/{supporter_id}/annual-summary:
post:
tags:
- Annual Summary
summary: Generate Annual Summary Report for Supporter
description: Generate an annual summary report PDF for the specified supporter and return a presigned S3 URL for download
operationId: generateSupporterAnnualSummary
parameters:
- name: supporter_id
in: path
description: The specified Supporter ID
required: true
schema:
type: integer
example: 1427264
requestBody:
content:
application/json:
schema:
properties:
report_year:
description: The year for the annual summary report
type: integer
example: 2024
start_date:
description: Start date for the report (optional, defaults to January 1st of report_year)
type: string
format: date
example: '2024-01-01'
end_date:
description: End date for the report (optional, defaults to December 31st of report_year)
type: string
format: date
example: '2024-12-31'
type: object
responses:
'200':
description: Annual summary report download information
content:
application/json:
schema:
properties:
download_url:
description: S3 presigned URL for file download
type: string
example: https://s3.amazonaws.com/bucket/file.pdf?presigned-params
filename:
description: Filename in format GivingSummary_[SupporterName]_YYYY.pdf
type: string
example: GivingSummary_JohnDoe_2024.pdf
expires_at:
description: ISO 8601 timestamp when the presigned URL expires
type: string
example: '2024-01-02T12:00:00+00:00'
file_size:
description: File size in bytes
type: string
example: '1048576'
content_type:
description: MIME type
type: string
example: application/pdf
type:
description: File type identifier
type: string
example: annual_summary
type: object
'403':
description: Requester is not authorized to perform action
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Supporter not found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
'422':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/MalformedPayloadResponse'
'500':
description: PDF generation or S3 upload failed
content:
application/json:
schema:
properties:
error:
type: string
example: Failed to generate annual summary report
message:
type: string
example: Error details
type: object
components:
schemas:
ResourceNotFoundResponse:
title: Resource Not Found Response
properties:
error:
description: Description of detected errors in request
type: string
type: object
MalformedPayloadResponse:
title: Malformed Payload Response
properties:
errors:
description: Description of detected errors in request
type: array
items:
type: string
example: Malformed JSON payload.
type: object
ForbiddenResponse:
title: Forbidden Response
properties:
error:
description: Description of detected error in request
type: string
example: This action is unauthorized.
type: object
securitySchemes:
OAuth2Application:
type: oauth2
description: OAuth bearer token for client application
flows:
clientCredentials:
tokenUrl: /oauth2/auth
refreshUrl: /oauth2/auth
scopes:
read: Read access
write: Write access
OAuth2Member:
type: oauth2
description: OAuth bearer token for client application with additional member context
flows:
password:
tokenUrl: /oauth2/auth
refreshUrl: /oauth2/auth
scopes:
read: Read access
write: Write access