Last updated: November 14, 2019
\nThe Financial Fitness Group API provides tools to measure outcomes along the journey of improving people's financial fitness.
\nThe API is divided into modules: assessments, contacts, and reporting. More modules are being exposed every week, as are more methods. Stay tuned in 2020!
\nIn order to use this API, you will need to obtain an API key and API secret pair for your environment.
\nThis API uses basic authentication. Note that all requests should be sent via HTTPS. Although non-encrypted HTTP traffic may be accepted by the service, the requests will receive a 302 redirect response to the same resource on HTTPS.
\nTechnically, there is no rate limit. However, if you expect to submit more than one call per second, please contact FFG.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Overview","slug":"overview"},{"content":"Environments","slug":"environments"},{"content":"Authentication","slug":"authentication"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"1538546","collectionId":"de41ad4b-3e94-4314-958b-39c849810b83","publishedId":"SW7W6W1B","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-11-15T12:21:26.000Z"},"item":[{"name":"Assessment","item":[{"name":"Latest results","id":"496373d6-45d9-4467-b729-55b8767540f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://www.ffgtest.com/v1/assessment/results/latest?contact=dd82fa38-3af6-4340-b17d-4ae908b1980a","description":"Get the most recent assessment results for a contact. It may return 404 if the contact exists, but hasn't yet completed any assessment.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The assessment module is used to measure and report on people's current level of financial fitness.
\nThe basic flow for full use of this API would be to request a template, present it however you see fit, gather the answers and post the payload, and show the user the scoring. However, FFG can also all of these steps via its own presentation system, and you can simply query the API for users' latest results; this is typical for larger SSO-backed integrations.
\n","event":[{"listen":"prerequest","script":{"id":"f15ad59f-a202-436e-8870-9243a031d2db","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d4c99a79-2f1c-4129-90b7-030999cf0f90","type":"text/javascript","exec":[""]}}],"_postman_id":"56ba6567-c827-4cc9-83bf-b4270c1518f3","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Given a user Id and group Id pair, find the contact in your organization that possesses those identifiers.
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"The contact's user Id as defined in the caller's system.
\n","type":"text/plain"},"key":"uid","value":"110"},{"description":{"content":"The contact's group Id as defined in the caller's system.
\n","type":"text/plain"},"key":"gid","value":"234"}],"variable":[]}},"response":[],"_postman_id":"20004b1f-9344-4011-a9d8-772bd6f28443"}],"id":"51e2d193-91f2-43af-b01b-8412854475f5","description":"The contacts module provides access to the people associated with your organization.
\n","event":[{"listen":"prerequest","script":{"id":"8387d174-7847-4513-af24-11bdec81a532","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"474c5245-9178-47e6-bf75-71df90b3c2d8","type":"text/javascript","exec":[""]}}],"_postman_id":"51e2d193-91f2-43af-b01b-8412854475f5","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns a raw data feed for all users in your organization, in JSON format. You may limit your requests to return only the users who have changed since a given time. For each user found, all of their data is returned.
\n","urlObject":{"protocol":"https","path":["api","v1","reporting","user-raw-data"],"host":["api","financialfitness","io"],"query":[{"description":{"content":"Optional. Specifies which page of the result set to return. Default 0, indicating the first page.
\n","type":"text/plain"},"key":"page","value":"Integer (e.g. 4) "},{"description":{"content":"Optional. Specifies the size of each page of data. Default 20.
\n","type":"text/plain"},"key":"size","value":"Integer (e.g. 10) "}],"variable":[]}},"response":[],"_postman_id":"5570c92b-5dd1-48f5-818c-0e8391312b6b"},{"name":"Raw user data modified after date","id":"0a0976ea-b7ec-44f5-bfed-c56f30a9a095","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"Returns one page of the raw data feed for all users in your organization, in JSON format. You may limit your requests to return only the users who have changed since a given time. For each user found, all of their data is returned.
\n","urlObject":{"protocol":"https","path":["api","v1","reporting","user-raw-data","search","findByModifiedDateAfter"],"host":["api","financialfitness","io"],"query":[{"description":{"content":"Required. Returns records modified since this time.
\n","type":"text/plain"},"key":"modifiedDate","value":"Date (e.g. 2019-11-15T04:40:00)"},{"description":{"content":"Optional. Specifies which page of the result set to return. Default 0, indicating the first page.
\n","type":"text/plain"},"key":"page","value":"Integer (e.g. 4) "},{"description":{"content":"Optional. Specifies the size of each page of data. Default 20.
\n","type":"text/plain"},"key":"size","value":"Integer (e.g. 10)"}],"variable":[]}},"response":[],"_postman_id":"0a0976ea-b7ec-44f5-bfed-c56f30a9a095"}],"id":"ca0622cf-0139-4251-ac99-a80123669c6b","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":false},"_postman_id":"ca0622cf-0139-4251-ac99-a80123669c6b","description":""}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"