{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"43aa1f58-020d-4671-98db-df0353f9cb7f","name":"SecureGive API v1","description":"Elevate your experience with the SecureGive API. These endpoints grant clients the ability to effortlessly access and integrate account data into their own applications. Additionally, you can harness the power of webhooks for action notifications, allowing proactive responses to key events within your account.\n\nIf there are any issues or questions, please contact SecureGive:\n\n> **SecureGive Support**  \n(855) 895-8951  \n[support@securegive.com](https://mailto:support@securegive.com) \n  \n\n# Get Started\n\nIn order to utilize this API, a SecureGive client must be on a plan that supports the use of the SecureGive API and/or Webhooks. If you are interested in adding these features please contact us to get started. Combining our API and Webhook technologies together allows for a powerful experience to build more efficient and responsive applications.\n\n# Generate API Key\n\nTo communicate with the SecureGive API, an API Key is required. Follow the steps below to generate an API key:\n\n1. Log in to SecureGive as an Administrator\n    \n2. Navigate to Settings > API Keys\n    \n3. Click `Add API Key`\n    \n4. Enter your API Key details\n    1. Nickname\n        1. A unique friendly name to remember what this API key is used for.\n            \n    2. Authorized Scopes\n        1. Defining which API endpoints you would like this API key to have permission to access. Best practice is to reduce scope as much as possible for security reasons.\n            \n    3. Expiration\n        1. Determining at what date you would like this API Key to expire and no longer work.\n            \n5. After saving, a modal will display your newly generated API Key. **NOTE: Please ensure to copy and securely store this key, as it will only be visible at this moment and is essential for subsequent steps**.\n    \n\nNow that you have an active API Key with defined permissions, you can continue with using the desired endpoints below to interact with your account information.\n\n# Revoke API Keys\n\nIf you need to revoke a SecureGive API key, the only option is to revoke all Active API Keys on your account. It is not possible to revoke a single API key. Follow the steps below to revoke your API keys within SecureGive:\n\n1. Log in to SecureGive as an Administrator\n    \n2. Navigate to Settings > API Keys\n    \n3. Click `Revoke All Keys`\n    \n4. Confirm that you approve this action and click `Revoke`\n    \n\nOnce you have confirmed this, all previously active API keys in your account will be marked as `Revoked` and no longer have permission to access the SecureGive API.\n\n# Generate Webhook\n\nTo receive messages from the SecureGive Webhook Service, setting up at least one webhook within your SecureGive account is required. Follow the steps below to generate a webhook notification:\n\n1. Log in to SecureGive as an Administrator\n    \n2. Navigate to Settings > Webhooks\n    \n3. Click `Add Webhook`\n    \n4. Enter your Webhook details\n    1. Nickname\n        1. A unique friendly name to remember what this Webhook is used for.\n            \n    2. Callback URL\n        1. Enter your URL that you want this webhook to send information to when it is triggered\n            \n    3. Trigger\n        1. Choose which one service you would like to be the trigger for this webhook. If you need to have multiple triggers, multiple webhooks can be created.\n            \n\nNow that you have an active Webhook, you can begin receiving communications at your specified Callback URL immediately when triggers are encountered.\n\n## Manage Webhooks\n\nIn SecureGive, Administrators have the flexibility to remove unnecessary webhooks or modify their details if updates are required. It's important to note that once deleted, the associated webhook callback URL will cease to receive notifications.\n\n## Webhook Delivery Request\n\nWhenever a trigger occurs and matches with any of the webhooks have been defined previously, a POST request will be sent to the callback URL of the associated webhook.\n\nA JSON data will be included in the request body and will be look like as follow:\n\n``` json\n{\n  \"id\": 42,\n  \"ts\": \"2024-03-22T15:22:26.5254170Z\",\n  \"scope\": \"member\",\n}\n\n ```\n\nTo be considered a successful delivery, the client must respond to the request with a 200 OK status code. The client then can use the information whether or not to get the latest state of the object by making an outgoing request to the SecureGive API endpoint.\n\n# Response Codes\n\n## Authentication error response\n\nIf an API key is missing, malformed, or invalid, you will receive a HTTP 401 Unauthorized response code.\n\nIf an API key is presented that does not have the requested endpoint in its authorized scopes, you will receive a HTTP 403 Forbidden response.\n\nThe API only responds to HTTPS-secured communications. Any requests sent via HTTP return a HTTP 301 redirect to the corresponding HTTPS resources.\n\n## Data responses\n\nIf valid data is found based on the url and any parameters, and returned successfully, you will receive a HTTP 200.\n\nIf the call was successful and there is no data expected on the return, you will receive a HTTP 204.\n\nIf a requested value is not found in the underlying data, you will receive a HTTP 404.\n\n## Rate and usage limits\n\nAPI access rate limits apply at a per-API key basis in unit time. The limit is 200 requests per minute.\n\nEach API response returns the following set of headers to help you identify your use status:\n\n| Header | Description |\n| --- | --- |\n| `X-Rate-Limit` | The maximum number of requests that the consumer is permitted to make per minute. |\n| `Retry-After` | The time at which the current rate limit window resets in UTC epoch seconds. |\n\nIf the request rate exceeds this limit, subsequent requests will receive an HTTP 429 response code.\n\n## Server error responses\n\nA HTTP `503` response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP `5XX` error, contact support.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"8557519","team":1024055,"collectionId":"43aa1f58-020d-4671-98db-df0353f9cb7f","publishedId":"2sA2rCSLaM","public":true,"publicUrl":"https://apidocs.securegive.com","privateUrl":"https://go.postman.co/documentation/8557519-43aa1f58-020d-4671-98db-df0353f9cb7f","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"30A6F5"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/26d164a9-8c30-4483-889d-42e232f68d78/U0cgTG9nb19XaGl0ZS5wbmc=","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"30A6F5"}},{"name":"light","logo":"https://content.pstmn.io/cfcb83aa-1a7e-45d2-89d0-65ad9435a52d/U0cgTG9nb19GdWxsIENvbG9yX1JHQi5wbmc=","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"30A6F5"}}]}},"version":"8.10.0","publishDate":"2024-03-13T17:16:11.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/cfcb83aa-1a7e-45d2-89d0-65ad9435a52d/U0cgTG9nb19GdWxsIENvbG9yX1JHQi5wbmc=","logoDark":"https://content.pstmn.io/26d164a9-8c30-4483-889d-42e232f68d78/U0cgTG9nb19XaGl0ZS5wbmc="}},"statusCode":200},"environments":[{"name":"SecureGive Client API","id":"4827cfb1-1ac4-442c-aa29-9ffd643c055e","owner":"10331082","values":[{"key":"BASE_URL","value":"https://api.securegive.com","enabled":true,"type":"default"},{"key":"API_KEY","value":"","enabled":true,"type":"secret"}],"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/3b253c6dd6f86f38f3411394f099605a49fef0ea7933b7d8bf723ff6096a1bc8","favicon":"https://res.cloudinary.com/postman/image/upload/v1708464556/team/wozassumm9icjk0zvhgv.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":"SecureGive Client API","value":"10331082-4827cfb1-1ac4-442c-aa29-9ffd643c055e"}],"canonicalUrl":"https://apidocs.securegive.com/view/metadata/2sA2rCSLaM"}