{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ca9f8a07-815e-4b2e-87d7-04415ef52932","name":"Ovrture API Documentation","description":"Welcome to the Ovrture API, currently under active development.\n\n# Overview\n\nAt this time, we are supporting the creation, read, update, and deletion of donors / prospects, funds, and fund data. The next phase of development for our external API will enable integrations with analytic data.\n\n# API Access URL and Keys\n\nSystem Admins can click \"API Key\" under \"Settings\" on the left hand menu of the Ovrture backend interface.\n\nEach Ovrture system has a unique subdomain for API Requests. This is displayed to System Admins on this page.\n\nAPI Keys are obtainable by the Ovrture System Admin through our application. Each system admin can have up to 2 active API keys at a time.\n\n## Authentication\n\nSecret to be converted into Base64 and then key and secret both to be attached to header of each API request.\n\n## Rate limit\n\nRequests are limited to 1 per second per Ovrture system.\n\n## Timeout\n\n60 seconds\n\n## Contact Support:\n\nEmail: [support@ovrture.com](https://mailto:support@ovrture.com) // Slack Channel\n\n## Response Codes\n\n```\nOK // code: 200\ndescription: Request successful\nCreated // code: 201\ndescription: Resource created successfully\nAccepted // code: 202\ndescription: Accepted for processing\nMulti Status // code: 207\ndescription: Multi status response\nIM Used // code: 226\ndescription: Already used data\nNot Modified // code: 304\ndescription: Operation could not performed\nBad Request Error // code: 400\ndescription: Invalid Request \nUnauthorized // code: 401\ndescription: Access to resource invalid\nNot Found // code: 404\ndescription: Tried to access a resource that does not exist\nMethod Not Allowed // code: 405\ndescription: Request using an unsupported method\nExpectation Failed // code: 417\ndescription: Response for expectation failed\nUser Unauthorized // code: 452\ndescription: Not authorized\nResponse Already Used // code: 453\ndescription: Response already used\nInternal Server Error // code: 500\ndescription: Problem within our server, try again later\nService Unavailable // code: 503\ndescription: Temporarily offline for maintenance, try again later\n\n ```\n\n## Server Response Properties\n\n```\ncode\ndatatype: <integer>\ndescription: Response Code \nmessage\ndatatype: <string>\ndescription: Response Message\nstatus\ndatatype: <string>\ndescription: Response Status\ndata\ndatatype: <object>\ndescription: Response Data object\n\n ```\n\n# Changelog\n\nSee what's new and the latest changes to the API here.\n\n### Feb 23, 2026\n\n> Added below apis  \n1\\. Find Session by Session Id  \n2\\. Find Snapshot  \n3\\. Find Snapshot list based on search params  \n4\\. Records Export Download  \n5\\. Download Report Distribution sheet  \n6\\. List Site  \n7\\. List Report  \n8\\. Download Email Bug for Site  \n9\\. Download Email Bug for Report  \n10\\. Download Live Snapshot for Site  \n11\\. Download Live Snapshot for Report  \n12\\. Download Site Distribution sheet  \nRemoved below apis  \n1\\. Finds Report Data Years  \n2\\. Finds Current Fiscal Year by orgId \n  \n\n### Jul 08, 2023\n\n> Analytics API added. \n  \n\n### May 23, 2023\n\n> **Caution:**  \nOur latest changes have led to breakages for the following endpoints that require attention.  \n`RecordsService.RecordXFundEndpoints.LinkFundsByRecordsId#PUT Account#update.RecordsService.RecordXFundEndpoints.LinkFundsByRecordsIdAndFund Id#PUT` \n  \n\n```\nResponses have been updated for the following endpoints.\nRecordsService.RecordEndpoints.ListRecordsByPageable#GET\nRecordsService.RecordXFundEndpoints.FindFundsByRecordsId#GET\nReportDataService.FundDataEndpoints.FindsFundDataByFundIdOrFundReferenceNumber#GET\nReportDataService.FundDataEndpoints.Updates Fund Data#PUT\nReportDataService.FundDataEndpoints.AddFundDatawithGivenInput#POST\nReportDataService.FundDataEndpoints.FindsFundDataDetailsByFundIdOrFundReferenceNumber#GET\nReportDataService.FundDataEndpoints.FindsFundDataListBasedOnSearchParams#GET\nReportDataService.FundDataEndpoints.FindsFundTypeList#GET\nReportDataService.FundDonorsEndpoints.FindsFundDonorsByFundDonorsIdAndReportYear#GET\nReportDataService.FundDonorsEndpoints.UpdatesFundDonors#PUT\nReportDataService.FundDonorsEndpoints.AddFundDonorsWithGivenInput#POST\nReportDataService.FundDonorsEndpoints.FindsFundDonorsListBasedOnSearchParams#GET\nReportDataService.FundImpactEndpoints.FindsFundDonorsByFundDonorsIdAndReportYear#GET\nReportDataService.FundImpactEndpoints.UpdatesFundDonors#PUT\nReportDataService.FundImpactEndpoints.AddFundDonorsWithGivenInput#POST\nReportDataService.FundImpactEndpoints.FindsFundDonorsListBasedOnSearchParams#GET\nReportDataService.FundImpactEndpoints.FindsAccessCriteriaForFundImpactList#GET\nReportDataService.FundImpactEndpoints.FundsImpactTypeList#GET\nReportDataService.FundPerformanceEndpoints.FindsFundPerformanceByFundPerformanceIdAndReportYear#GET\nReportDataService.FundPerformanceEndpoints.UpdatesFundPerformance#PUT\nReportDataService.FundPerformanceEndpoints.AddFundPerformanceWithGivenInput#POST\nReportDataService.FundPerformanceEndpoints.FindsFundPerformanceListBasedOnSearchParams#GET\nAdd support for new value colExtraLongFundDescription on endpoint ReportDataService.FundDataEndpoints.UpdatesFundData#PUT in request body\nAdd support for new value colExtraLongFundDescription on endpoint ReportDataService.FundDataEndpoints.AddFundDatawithGivenInput#POST\nAdd support for new value colFdMatchFy0 on endpoint ReportDataService.FundDonorsEndpoints.UpdatesFundDonors#PUT\nAdd support for new value colFdMatchFy0 on endpoint ReportDataService.FundDonorsEndpoints.AddFundDonorsWithGivenInput#POST\nAdd support for new value colImpactNarrative on endpoint ReportDataService.FundImpactEndpoints.UpdatesFundDonors#PUT\nAdd support for new value colImpactNarrative on endpoint ReportDataService.FundImpactEndpoints.AddFundDonorsWithGivenInput#POST\nAdd support for new values colFpLongFooterNote, colFpBeginningValueFy1, colFpBeginningValueFy2, colFpGiftsFy1, colFpGiftsFy2 on endpoint ReportDataService.FundPerformanceEndpoints.UpdatesFundPerformance#PUT\nAdd support for new values colFpLongFooterNote, colFpBeginningValueFy1, colFpBeginningValueFy2, colFpGiftsFy1, colFpGiftsFy2 on endpoint ReportDataService.FundPerformanceEndpoints.AddFundPerformanceWithGivenInput#POST\n\n ```\n\n### June 19, 2024\n\n> Added flag bit to get unzipped snapshot files on endpoint `AnalyticsService.AnalyticsEndpoints.DownloadSnapshot#GET`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"14723479","team":1610612,"collectionId":"ca9f8a07-815e-4b2e-87d7-04415ef52932","publishedId":"2s93sacEK3","public":true,"publicUrl":"https://api.ovrture.com","privateUrl":"https://go.postman.co/documentation/14723479-ca9f8a07-815e-4b2e-87d7-04415ef52932","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2023-06-09T06:50:46.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"External Environment","id":"6cab4293-c917-4324-857e-c979af90d4e9","owner":"14723479","values":[{"key":"baseURL","value":"https://client.api.production.ovrture.io","enabled":true},{"key":"apiKey","value":"XXXXXXXXXXXX","enabled":true},{"key":"apiSecret","value":"XXXXXXXXXXXXXXXXXX","enabled":true},{"key":"reportDataServicePath","value":"{{baseURL}}/reportdataservice/v1/api/report/data","enabled":true},{"key":"recordsServicePath","value":"{{baseURL}}/recordsservice/v1/api/records","enabled":true},{"key":"analyticsServicePath","value":"{{baseURL}}/analyticsservice/v1/api/analytics","enabled":true,"type":"default"}],"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/973b4ee66d6c300e09f0d9267e065fa6fbb9755d7090facf8772995cfac5a5f2","favicon":"https://res.cloudinary.com/postman/image/upload/v1626682109/team/k0rf5wpsr3qu7ruhuecw.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":"External Environment","value":"14723479-6cab4293-c917-4324-857e-c979af90d4e9"}],"canonicalUrl":"https://api.ovrture.com/view/metadata/2s93sacEK3"}