{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cf36915e-4623-4051-bb58-21e8f09f6ec1","name":"Flourish External API - Docs","description":"**Flourish External API** allows you to access your Flourish data programmatically.\n\n# Authentication\n\nThe [Basic Auth](https://en.wikipedia.org/wiki/Basic_access_authentication) method is now deprecated and should no longer be used to access the Flourish API. The new and recommended method of authentication is via **API Key**, using the `x-api-key` header.\n\nTo authenticate, generate a new API key from within the Flourish web app (refer to our help documentation for guidance). Once you have your key, include it in your API requests using the `x-api-key` header.\n\n# Types\n\nThere are some core types referenced throughout the documentation. Use this as a reference when those types are mentioned.\n\n- string: A sequence of letters, numbers, and characters enclosed in \"\".\n    \n- number: Generally used to represent any number from a large integer to high precision floats like 1.2345.\n    \n- date: A single day, represented as YYYY-MM-DD. An example would be 2021-02-28.\n    \n- datetime: A point in time, represented as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp. An example would be 2020-01-03T15:04:05.000Z. The Z here signifies that this time is UTC.\n    \n- array: A collection of one or more items of the same type, which should be wrapped in \\[\\] in the JSON.\n    \n\n# Query Parameters\n\nQuery parameters may be passed with some queries as a part of the URL to indicate filters for a query. These should be passed after the URL, like:\n\n`https://app.flourishsoftware.com/external/api/v1/items?param1=one&param2=two`.\n\nWhen parameters are described for a particular API endpoint, being surrounded by \\[\\] indicates that the parameter may be passed more than once. For example the parameter item_name with type \\[string\\] may be passed multiple times, like:\n\n`https://app.flourishsoftware.com/external/api/v1/items?item_name=item1&item_name=item2&item_name=item3`\n\n# Status Codes\n\nEach response will return a status code which can help identify the status of the request and what action, if any, should be taken next. [httpstatuses](https://httpstatuses.com/) is an excellent reference for HTTP status codes and what they may mean.\n\n# Webhooks\n\nWebhooks allow the Flourish external API to work in reverse. Register a webhook server address along with resource event types and whenever one of those resources is updated Flourish will send the data to your server.\n\nWebhooks can be configured through the Flourish web application by administrators by navigating to Manage Settings > Integrations > Webhook Endpoints. Each endpoint can choose which resource event types to subscribe to. Any supported event will result in a message being sent to the registered address. Webhook configuration changes may take a few minutes to become active.\n\nExample webhook message body:\n\n```\n{\n    \"action\": \"create\",\n    \"resource_type\": \"retail_order\",\n    \"data\": {...}\n}\n\n ```\n\nThe shape of \"data\" is the same as it would be when requesting the resource through the external API so the same structure can be used for both. Like requests to the external API, webhook data is declarative. It does not show changes, but data as it exists when the message is sent. A single action in Flourish may result in multiple messages being sent as the resource is modified so the latest received message for a resource should take precedence over any that came before it.\n\nWebhook endpoints also support custom headers, which can be used to ensure the message is coming from Flourish. Add a header key/value pair and verify it matches when receiving messages. This is highly recommended as a basic verification for any incoming data.\n\nSee the list of supported webhooks [here](https://docs.flourishsoftware.com/article/am15rjpmvg-flourish-webhooks).","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"8546587","collectionId":"cf36915e-4623-4051-bb58-21e8f09f6ec1","publishedId":"SVtVSnbf","public":true,"publicUrl":"https://api-docs.flourishsoftware.com","privateUrl":"https://go.postman.co/documentation/8546587-cf36915e-4623-4051-bb58-21e8f09f6ec1","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2021-11-09T22:53:59.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"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/b01f32e1456c832dbb55b62708fa822cbd65cd7f9e7f51fd0292ba72498232bf","favicon":"https://res.cloudinary.com/postman/image/upload/v1590163797/team/hpx0mplerv7e3daemdhg.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"}],"canonicalUrl":"https://api-docs.flourishsoftware.com/view/metadata/SVtVSnbf"}