{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"3733deb4-28a7-4b25-a0ea-46d6f722774f","name":"RallyUp Partner API V2","description":"Our Partner API provide partners the ability to:\n\n1.  Pull organizational info of the partners' customers\n2.  Pull campaign info of the partners' customers' campaigns\n3.  Pull transactional info of the partners' customers' campaigns\n4.  Pull details on items available on the partner's customers' campaigns\n5.  Generate organizational API credentials for the partners' customers (organizational API calls can be found at [api.rallyup.com](api.rallyup.com))\n6.  **For partners using a Custom Organization List only:** Manage custom organizations and their administrators/staff\n    \n\n# Authentication\n\nAPI calls require an authorization token to be passed as a Bearer token in the header. These tokens expire in 7 days, and can be generated via a call to the /v1/partnertoken endpoint with your partner API credentials. Partner API credentials can be generated by RallyUp staff. Contact RallyUp staff at [support@rallyup.com](mailto:support@rallyup.com) to get set up.\n\n# Response\n\nResponses contain four pieces of information: the **Result** object, an **Ok** status, **Error** information, and **Metadata**.\n\nThe **Result** is the response object received from the API call.\n\n**Ok** is a boolean that represents whether or not the call made was successfully processed.\n\n**Error** gives the reason of the error if **Ok** is false.\n\n**Metadata** will contain any warning or supplementary information about the API call.\n\n# Pagination\n\nSome of the endpoints below return paginated results. In this case, the results will contain a **paginated object**, containing the following information:  \n**Items**, **Count**, **PageIndex**, **PageSize**, **TotalCount**, **TotalPages**, **HasPreviousPage**, **HasNextPage**.\n\n**Items** is an array of objects returned with the API call.\n\n**Count** is the number of results returned on the current page (i.e., the length of **Items**).\n\n**PageIndex** is the page number of the current page.\n\n**PageSize** is the maximum number of results per page.\n\n**TotalCount** is the total number of results that match the request criteria (i.e., the sum of **Count** for all pages)\n\n**TotalPages** is the total number of pages that contain results.\n\n**HasPreviousPage**/**HasNextPage** are booleans that represents if there is a previous/next page.\n\n# Webhooks\n\nAs a partner administrator, you have access to create webhooks through your partner administrator dashboard and select events to subscribe to. When these events occur in your private label partner platform, a POST request will be sent to the webhook URL.\n\nHere are the types of events available to be subscribed to:\n\n**UserInfoEntered**: This event triggers when a user completes the name, email, and password creation fields on the first step of the Start Page, then clicks \"Continue\" to move onto the next step.\n\n**OrgInfoEntered**: This event triggers when a user completes their organization information fields on the second step of the Start Page, then clicks \"Start Fundraising\" to move onto the landing page in the application.\n\n**OrgVerificationSubmitted:** This event is only available if your private label app uses RallyUp's Stripe Identity and Guidestar verification process to verify organization identities. This event occurs when the user has submitted verification for their organization.\n\n**OrgPaymentProcessingSetUp:** This event occurs when an organization has saved changes to the Payment Processing settings.\n\n**OrgApproved:** This event occurs when an organization goes into \"Approved\" status.\n\n**CampaignDraftCreated:** This event occurs when a user creates a draft campaign via clicking the \"Next\" button on the basics step of Campaign Setup.\n\n**CampaignPublished:** This event occurs when a user publishes a campaign.\n\n**CampaignApprovalStatusChanged:** This event occurs when a campaign's status changes to \"Approved\", \"Frozen\", \"Declined\", \"Cancelled\", or \"Returned\" status.\n\n**CampaignEnded:** This event occurs when a campaign's status changes to \"Ended\", \"Processing\", or \"Completed\".\n\n**UserUpdated:** This event occurs when a non-donor user changes their first name or last name in their profile settings.\n\n**UserDeleted:** This event occurs when a user is deleted.\n\n**UserAddedOnOrg:** This event occurs when a user is added as an administrator or staff on an organization.\n\nEach event with a **User** prefix will contain a user object in the POST request.  \nEach event with a **Campaign** prefix will contain a campaign object in the POST request.  \nEach event with an **Org** prefix will contain an organization object in the POST request.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4028925","team":100549,"collectionId":"3733deb4-28a7-4b25-a0ea-46d6f722774f","publishedId":"U16dR8ME","public":true,"publicUrl":"https://partnerapi.rallyup.com","privateUrl":"https://go.postman.co/documentation/4028925-3733deb4-28a7-4b25-a0ea-46d6f722774f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-08-31T22:28:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Partner Environment","id":"0e054da3-47c9-478c-9135-1e00a727a9c1","owner":"4028925","values":[{"key":"Partner Domain","value":"my.partnerdomain.com","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/95624a4429007400976b4207eda017c2238bed2f850489cc58d9859bc0c3cadc","favicon":"https://rallyup.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Partner Environment","value":"4028925-0e054da3-47c9-478c-9135-1e00a727a9c1"}],"canonicalUrl":"https://partnerapi.rallyup.com/view/metadata/U16dR8ME"}