openapi: 3.2.0
info:
title: GoFundMe Pro Social Video 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: Social Video
description: Social Video
paths:
/studio-campaigns/{campaign_id}/share-settings/social-videos:
post:
tags:
- Social Video
summary: createStudioCampaignSocialVideo
description: Creates a new social video for a studio campaign. The API automatically extracts most data from the campaign, with client-provided values treated as overrides.
operationId: createStudioCampaignSocialVideo
parameters:
- name: campaign_id
in: path
description: Campaign ID
required: true
schema:
type: integer
example: 12345
requestBody:
description: The API requires only minimal data (persona, description, main_image) and automatically extracts the rest from the campaign. Any additional fields provided will override the extracted data.
content:
application/json:
schema:
required:
- persona
- description
- main_image
properties:
persona:
description: The persona for which the video is created
type: string
example: donor
description:
description: Description of the video
type: string
example: Thank you for your donation
main_image:
description: URL of the main image to use in the video
type: string
example: https://example.com/image.jpg
theme_data:
description: Theme data for the video (optional override - individual properties can be provided without specifying all)
properties:
primary_color:
description: Optional override for primary color
type: string
example: '#FF0000'
secondary_color:
description: Optional override for secondary color
type: string
example: '#00FF00'
font_color:
description: Optional override for font color
type: string
example: '#000000'
font_name:
description: Optional override for font name (client has specialized font mapping knowledge)
type: string
example: Sans Serif
type: object
logo_image:
description: URL of the logo image to use in the video (optional override)
type: string
example: https://example.com/logo.jpg
hero_image:
description: URL of the hero image to use in the video (optional override)
type: string
example: https://example.com/hero.jpg
campaign_content:
description: Campaign content for the video (optional override - the API will extract content from campaign pages if not provided)
properties:
campaign_title:
description: Optional override for campaign title
type: string
example: Campaign Title
campaign_paragraphs:
description: Optional override for campaign paragraphs
type: string
example: '[P1] First paragraph\n\n[P2] Second paragraph'
campaign_headings:
description: Optional override for campaign headings
type: string
example: '[H1] First heading\n\n[H2] Second heading'
campaign_text:
description: Optional override for all campaign text
type: string
example: '[TITLE] Campaign Title\n\n[HEADING 1] First heading\n\n[PARAGRAPH 1] First paragraph'
type: object
type: object
responses:
'201':
description: Success - The API has accepted the request and started the video generation process. The server will gather all necessary data from the campaign, applying any provided overrides.
content:
application/json:
schema:
properties:
status:
description: The initial status of the video generation job
type: string
example: pending
message:
description: A success message
type: string
example: Video generation job created successfully
type: object
'403':
description: Requester is not authorized to perform action
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Campaign not found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
'400':
description: Validation error
content:
application/json:
schema:
properties:
message:
type: string
example: The given data was invalid.
errors:
type: object
example:
persona: The persona field is required.
description: The description field is required.
type: object
security:
- OAuth2Member: []
/studio-campaigns/{campaign_id}/share-settings/social-videos/{persona}:
get:
tags:
- Social Video
summary: getStudioCampaignSocialVideo
description: Retrieves a specific social video for a studio campaign by persona
operationId: getStudioCampaignSocialVideo
parameters:
- name: campaign_id
in: path
description: Campaign ID
required: true
schema:
type: integer
example: 12345
- name: persona
in: path
description: Persona type (e.g., donor)
required: true
schema:
type: string
example: donor
responses:
'200':
description: Success
content:
application/json:
schema:
properties:
id:
type: string
example: '12345'
entity_type:
type: string
example: studio_campaign
entity_id:
type: string
example: '12345'
persona:
type: string
example: donor
description:
type: string
example: Thank you for your donation
main_image:
type: string
example: https://example.com/image.jpg
is_enabled:
type: boolean
example: true
status:
type: string
example: completed
url:
type: string
example: https://example.com/video.mp4
thumbnail_url:
type: string
example: https://example.com/thumbnail.jpg
created_at:
type: string
format: date-time
example: '2023-01-01T12:00:00Z'
updated_at:
type: string
format: date-time
example: '2023-01-01T12:30:00Z'
type: object
'403':
description: Requester is not authorized to perform action
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Campaign or social video not found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
/studio-campaigns/{campaign_id}/share-settings/social-videos/{persona}/status:
put:
tags:
- Social Video
summary: updateStudioCampaignSocialVideoStatus
description: Updates the enabled status of a social video for a studio campaign
operationId: updateStudioCampaignSocialVideoStatus
parameters:
- name: campaign_id
in: path
description: Campaign ID
required: true
schema:
type: integer
example: 12345
- name: persona
in: path
description: Persona type (e.g., donor)
required: true
schema:
type: string
example: donor
requestBody:
content:
application/json:
schema:
required:
- is_enabled
properties:
is_enabled:
description: Whether the social video is enabled
type: boolean
example: true
type: object
responses:
'200':
description: Success
content:
application/json:
schema:
properties:
is_enabled:
type: boolean
example: true
type: object
'403':
description: Requester is not authorized to perform action
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Campaign not found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
'422':
description: Validation error
content:
application/json:
schema:
properties:
message:
type: string
example: The given data was invalid.
errors:
type: object
example:
is_enabled: The is_enabled field is required.
type: object
'400':
description: Bad Request - Invalid persona or no video exists
content:
application/json:
schema:
properties:
error:
description: Error message
type: string
example: 'Invalid persona. Must be one of: donor, fundraiser, team_member'
type: object
'500':
description: Internal server error
content:
application/json:
schema:
properties:
error:
type: string
example: Failed to update social video settings
type: object
security:
- OAuth2Member: []
/social-videos/entity:
get:
tags:
- Social Video
summary: getSocialVideoByEntity
description: Retrieves the status and details of a social video for a specific entity
operationId: getSocialVideoByEntity
parameters:
- name: entity_type
in: query
description: Entity type (e.g., studio_campaign)
required: true
schema:
type: string
example: studio_campaign
- name: entity_id
in: query
description: Entity ID
required: true
schema:
type: string
example: '12345'
- name: persona
in: query
description: Persona type (e.g., donor)
required: true
schema:
type: string
example: donor
responses:
'200':
description: Success
content:
application/json:
schema:
properties:
id:
type: string
example: '12345'
status:
type: string
example: completed
url:
type: string
example: https://example.com/video.mp4
thumbnail_url:
type: string
example: https://example.com/thumbnail.jpg
created_at:
type: string
format: date-time
example: '2023-01-01T12:00:00Z'
updated_at:
type: string
format: date-time
example: '2023-01-01T12:30:00Z'
type: object
'403':
description: Requester is not authorized to perform action
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
'404':
description: Social video not found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundResponse'
components:
schemas:
ForbiddenResponse:
title: Forbidden Response
properties:
error:
description: Description of detected error in request
type: string
example: This action is unauthorized.
type: object
ResourceNotFoundResponse:
title: Resource Not Found Response
properties:
error:
description: Description of detected errors in request
type: string
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