{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"626b166d-31e0-4fbb-b124-96f83c7eaea0","name":"Fuel Cycle Public API","description":"# Fuel Cycle Overview\n\nFuel Cycle generates market research communities where our partners invite members to participate in market research studies.\n\nWithin communities, partners set up [activities](https://support.fuelcycle.com/hc/en-us/articles/4416417028891), which you can think of as placeholders or containers. Within these activities, partners link [surveys](https://support.fuelcycle.com/hc/en-us/articles/8302654318875-Fuel-Cycle-Public-API#h_01GEMXBS9N4STD60J3V2CFN9FJ) and [partner studies](https://support.fuelcycle.com/hc/en-us/articles/4417399222043) to the activity. There may be multiple elements besides surveys or studies within the activity. Partners can also set up [Delta Testing](https://support.fuelcycle.com/hc/en-us/articles/4417244915867-Delta-Testing) to track, respond, and resolve user feedback.\n\nWhen these elements are linked to a Fuel Cycle activity, members see a button that links to that element to reserve an appointment, join, or take action.\n\n# API Overview\n\n\\* Add or update activities through the Core API.\n\n\\* Add or update studies through the FCX (Fuel Cycle Exchange) API.\n\n\\* Add or update member participants through the Commons API.\n\n\\* Add or update member surveys and responses through the Survey API.\n\nYou will need an application in the middle to transfer the data back and forth and transform it so that each system understands it.\n\nFuel Cycle currently has four REST APIs:\n\n1. Use the **Commons API** to request custom member data ([P2 Engine data](https://support.fuelcycle.com/hc/en-us/articles/4417424569371)) for a specific member.\n    \n2. Use the **Core API** to:\n    1. Utilize the custom member profiling (P2 engine) data.\n        \n    2. Request the total number of members within a community with certain profile variables.\n        \n    3. Create, update, or view [delta testing](https://support.fuelcycle.com/hc/en-us/articles/4417244915867) tickets, comments, and projects.\n        \n    4. Create or update an activity.\n        \n3. Use the **FCX API** to create, update, or view an [FCX study](https://support.fuelcycle.com/hc/en-us/articles/4417399222043).\n    \n4. Use the **Survey API** to create, update, or view [surveys and responses](https://support.fuelcycle.com/hc/en-us/articles/8302654318875-Fuel-Cycle-Public-API#h_01GEMXBS9N4STD60J3V2CFN9FJ) from any service provider\n    \n\n# **API Base URLs**\n\n\\* **Production Base URL**: api.fuelcyclecore.com\n\n\\* **Stage Base URL**: api.fuelcyclestage.com\n\n# **API Keys/Tokens**\n\n\\* Each community will be assigned a key and token to communicate with Fuel Cycle’s API. If you have multiple communities with Fuel Cycle, you will need separate keys and tokens for each individual community.\n\n\\* Each of the three Fuel Cycle APIs (Core, Commons, and FCX) requires a unique key and token.\n\n\\* Core and FCX APIs require unique keys and tokens. Commons endpoints can be accessed using either API credentials.\n\n\\* There are separate keys and tokens for our stage and production environments.\n\n# **API Service Level Agreement**\n\nWe guarantee the same SLA as provided in our client/partner contracts\n\n\\* 99.99% up-rate\n\n\\* No rate limits\n\n# **API Errors and Timeouts**\n\n\\* Our system timeout is 30 seconds, but all our APIs should respond within less than 1-2 seconds.\n\n\\* It is safe to set the timeout parameter in your system to a maximum of 10 seconds.\n\n\\* In the case of missing or invalid parameters, we return status code 200 with the proper message in the response.\n\n| Code | Description |\n| --- | --- |\n| 200 OK | Successful request. |\n| 400 Bad Request | This error is displayed typically when the URL reference is incorrect and/or is referencing the wrong ID. This error can also occur when the API request has missing or unexpected parameters. |\n| 401 Unauthorized | Verify that your API key and token access credentials are correct. |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2475141","team":607678,"collectionId":"626b166d-31e0-4fbb-b124-96f83c7eaea0","publishedId":"UVsFz8y5","public":true,"publicUrl":"https://api.fuelcycle.com","privateUrl":"https://go.postman.co/documentation/2475141-626b166d-31e0-4fbb-b124-96f83c7eaea0","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2022-03-10T18:29:02.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/180b4eddf1fd05ea039b0c05e19c56a97b257fa73f3a188cd1bc2de975627c32","favicon":"https://res.cloudinary.com/postman/image/upload/v1646936791/team/vunfh2pfx31tqnmioxcw.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.fuelcycle.com/view/metadata/UVsFz8y5"}