{
  "opencollection": "1.0.0",
  "info": {
    "name": "GoFundMe Pro Supporter API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "oauth2",
      "flow": "client_credentials",
      "accessTokenUrl": "/oauth2/auth",
      "credentials": {
        "clientId": "{{clientId}}",
        "clientSecret": "{{clientSecret}}"
      }
    }
  },
  "items": [
    {
      "info": {
        "name": "Supporter",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Send Annual Summary Email to Supporter (Admin)",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pro.gofundme.com/api/2.0/organizations/:organization_id/supporters/:supporter_id/annual-summary",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "The specified Organization ID"
              },
              {
                "name": "supporter_id",
                "value": "",
                "type": "path",
                "description": "The specified Supporter ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/oauth2/auth",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Send an annual summary email to a specific supporter. This is an admin-initiated action that does not require a bulk batch send."
        },
        {
          "info": {
            "name": "Generate Annual Summary Report for Supporter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pro.gofundme.com/api/2.0/supporters/:supporter_id/annual-summary",
            "params": [
              {
                "name": "supporter_id",
                "value": "",
                "type": "path",
                "description": "The specified Supporter ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Generate an annual summary report PDF for the specified supporter and return a presigned S3 URL for download"
        },
        {
          "info": {
            "name": "listCampaignSupporters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pro.gofundme.com/api/2.0/campaigns/:campaign/supporters",
            "params": [
              {
                "name": "campaign",
                "value": "",
                "type": "path",
                "description": "The specified Campaign ID"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Indicator of which page of results to return"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of entries to return in each page of results"
              }
            ]
          },
          "docs": "Retrieves a list of all Supporters for a specific Campaign"
        },
        {
          "info": {
            "name": "listOrganizationSupporters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pro.gofundme.com/api/2.0/organizations/:organization/supporters",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path",
                "description": "The specified Organization ID"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Indicator of which page of results to return"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of entries to return in each page of results"
              }
            ]
          },
          "docs": "Retrieves a list of all Supporters for a specific Organization"
        },
        {
          "info": {
            "name": "createOrganizationSupporter",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pro.gofundme.com/api/2.0/organizations/:organization/supporters",
            "params": [
              {
                "name": "organization",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/oauth2/auth",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Create a Supporter for an Organization"
        },
        {
          "info": {
            "name": "listAsrMessages",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pro.gofundme.com/api/2.0/organizations/:org_id/supporters/:supporter_id/messages/asrs",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "The specified Organization ID"
              },
              {
                "name": "supporter_id",
                "value": "",
                "type": "path",
                "description": "The specified Supporter ID"
              }
            ]
          },
          "docs": "Retrieves an array with recipientsIds, template_name, year and message_id for Annual Summary Report wrt Supporters for a specific Organization"
        },
        {
          "info": {
            "name": "showSupporterForAuthedMember",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pro.gofundme.com/api/2.0/organizations/:organization_id/supporters/me",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "The specified Organization ID"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/oauth2/auth",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Retrieves the Supporter record for the authenticated Member within the specified Organization."
        },
        {
          "info": {
            "name": "fetchSupporter",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://pro.gofundme.com/api/2.0/supporters/:supporter",
            "params": [
              {
                "name": "supporter",
                "value": "",
                "type": "path",
                "description": "The specified supporter ID"
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of fields to be returned"
              }
            ]
          },
          "docs": "Retrieves Supporter from ID"
        },
        {
          "info": {
            "name": "updateSupporter",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://pro.gofundme.com/api/2.0/supporters/:supporter",
            "params": [
              {
                "name": "supporter",
                "value": "",
                "type": "path",
                "description": "The specified Supporter ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/oauth2/auth",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Updates an existing Supporter"
        },
        {
          "info": {
            "name": "deleteSupporter",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://pro.gofundme.com/api/2.0/supporters/:supporter",
            "params": [
              {
                "name": "supporter",
                "value": "",
                "type": "path",
                "description": "Primary identifier of Supporter"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/oauth2/auth",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Delete a Supporter"
        },
        {
          "info": {
            "name": "supporterAnnualSummary",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://pro.gofundme.com/api/2.0/supporters/:id/send-annual-summary",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The specified Supporter ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "resource_owner_password_credentials",
              "accessTokenUrl": "/oauth2/auth",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Request an annual summary to be sent to a supporter for a specific year"
        }
      ]
    }
  ],
  "bundled": true
}