These API Development Terms and Conditions (these \"Terms\") constitute a binding legal agreement between you (either an individual or an entity, \"you\" or \"Development User\") and Beam Health, Inc. (\"Beam Health,\" \"we,\" or \"us\") regarding your access to: (a) the Beam Health database via Beam Health's standard application programming interface(s) and related information and documentation (the \"API,\" and the provision of such access by Beam Health, the \"Services\"); and (b) any software development kits and information or documentation related to the Services made available by Beam Health (the \"Development Software\").
\nPlease read these Terms carefully. By clicking \"I Accept\" or otherwise using the Services or Development Software, you agree to be bound by these Terms and to use the Services and Development Software in compliance with these Terms. If you are registering for access to, or otherwise accessing or using, the Services and Development Software on behalf of a company or other legal entity, then you and such company or entity represent and warrant that: (i) you have the right and legal authority to bind such company or entity to these Terms; (ii) such company or entity is fully aware of, understands, and agrees to be bound by these Terms (with the terms \"Development User\" and \"you\" as used herein referring also to such company or entity), and (iii) you agree to be bound by these Terms on behalf of such company or entity. If you do not qualify to use the Services or Development Software, or do not agree to these Terms, then you should not and may not register for, access, or use the Services or Development Software.
\nTHE SERVICES AND DEVELOPMENT SOFTWARE MUST BE USED ONLY BY THE DEVELOPMENT USER IN A NON-PRODUCTION ENVIRONMENT, FOR THE PURPOSE OF INTERNAL EVALUATION AND DEVELOPMENT USE ONLY AND SOLELY IN ACCORDANCE WITH ALL LIMITATIONS SET FORTH IN THESE TERMS OR ON THE SIGN-UP PAGE, OR OTHERWISE COMMUNICATED TO DEVELOPMENT USER BY BEAM HEALTH (\"DEVELOPMENT PURPOSES\"). DEVELOPMENT USER SHALL NOT TRANSMIT, UPLOAD, INPUT OR OTHERWISE DISCLOSE TO BEAM HEALTH THROUGH THE SERVICES OR DEVELOPMENT SOFTWARE MADE AVAILABLE IN CONNECTION WITH THIS AGREEMENT ANY DATA CONCERNING ACTUAL PERSONS, INCLUDING WITHOUT LIMITATION ANY PERSONALLY IDENTIFIABLE INFORMATION, PROTECTED HEALTH INFORMATION, HEALTH DATA OR OTHER DATA SUBJECT TO HIPAA.
\nIf you wish to purchase a production use license to the Services or to transmit personally identifiable information, protected health information, health data, or other data subject to HIPAA through the API or Service, please contact Beam Health at api@Beam Health.com.
\nSubject to Development User's compliance with these Terms: (i) Beam Health hereby agrees that Development User has the right to access and use the Services during the Term (as defined below) for Development Purposes only, and only in accordance with Beam Health's applicable user documentation and written instructions; and (ii) Beam Health hereby grants Development User, during the Term, a limited, non-sublicensable, non-transferable, non-exclusive license to use the Development Software solely for the purposes of (a) allowing Development User to use the Services and Development Software in connection with one or more Development User-controlled software applications, products, websites, or online services that communicate with the Services (\"Development User Applications\") and (b) using such Development User Applications to send queries to Beam Health using the API and retrieve data (\"Sample Data\") through the API, in each case (a) and (b) solely for Development Purposes, not for any commercial or production use and subject to the limitations imposed by access to the API in \"Restricted Mode.\"
\nBeam Health shall have no obligation under these Terms or otherwise to provide the Services or Development Software. Development User understands that Beam Health may change, suspend, or discontinue any aspect of the API or Services, or may impose limits on Development User's usage of, or disable certain features or restrict access to parts or all of, the API or the Services, at any time without notice or liability. If Beam Health provides Development User with any upgrades, patches, enhancements, fixes or modifications to the Development Software, then the same will become part of the applicable part(s) of the Development Software, and subject to these Terms.
\nOwnership; Feedback
\nOwnership. As between the parties, Beam Health retains all of its right, title, and interest in and to the Services, the results of the Services (including, without limitation, Sample Data), the Development Software, and all software, products, works, and other intellectual property and moral rights related thereto or created, used, or provided by Beam Health for the purposes of these Terms, including any copies and derivative works of the foregoing. No rights or licenses are granted to Development User by Beam Health except as expressly and unambiguously set forth in these Terms.
\nFeedback. Development User may from time to time provide suggestions, comments or other feedback to Beam Health with respect to the Development Software, Sample Data and/or the Services (collectively, \"Feedback\"). Notwithstanding anything to the contrary, Feedback, even if designated as confidential by Development User, shall not create any confidentiality obligation for Beam Health. Development User shall, and hereby does, grant to Beam Health a nonexclusive, worldwide, perpetual, irrevocable, transferable, sublicensable, royalty-free, fully paid up license to use and exploit the Feedback for any purpose. For purposes of clarity, nothing in these Terms will be interpreted to restrict or impair Beam Health's right to develop, acquire, license, market, promote or distribute products, software or technologies that perform the same or similar functions as the Development User Applications, or otherwise compete with any products, software or technologies that Development User may develop, produce, market, or distribute.
\nRestrictions
\nGenerally. Except as expressly set forth in these Terms, Development User shall not (and shall not permit any third party to), directly or indirectly: (i) reverse engineer, decompile, disassemble, or otherwise attempt to discover the source code, object code, or underlying structure, ideas, or algorithms of the Services, or Development Software (except to the limited extent applicable laws specifically prohibit such restriction); (ii) modify, translate, or create derivative works based on the Services or Development Software; (iii) copy, rent, lease, distribute, pledge, assign, or otherwise transfer or encumber rights to the Services or Development Software; (iv) use the Services or Development Software for any purpose other than Development Purposes; (v) remove or otherwise alter any proprietary notices or labels from the Services or Development Software, or any portion thereof; (vi) modify or extend the Services or Development Software to any extent; (vii) separately use any portion of any Services or Development Software apart from Development User's use of such Services or Development Software as a whole as part of the Development User Application for Development Purposes; (viii) contaminate, incorporate, integrate, link or bundle any portion of the Services or Development Software with any software code governed by open source, community source, freeware, shareware, or other public license or distribution model software; (ix) use the Services or Development Software to build an application or product that is competitive with any Beam Health product or service; (x) interfere or attempt to interfere with the proper working of the Services or any activities conducted on the Services; or (xi) bypass any measures Beam Health may use to prevent or restrict access to the Services (or other accounts, computer systems or networks connected to the Services). Development User shall not (and shall not permit any third party to), directly or indirectly, take any action or (including without limitation uploading, downloading, posting, submitting or otherwise distributing or facilitating distribution of any material on or through the Services), that: (a) infringes any patent, trademark, trade secret, copyright, right of publicity or other right of any other person or entity; (b) is unlawful, threatening, abusive, harassing, defamatory, libelous, deceptive, fraudulent, invasive of another's privacy, tortious, obscene, offensive, or profane; (c) constitutes unauthorized or unsolicited advertising, junk or bulk e-mail (\"spamming\"); (d) contains software viruses or any other computer codes, files, or programs that are designed or intended to, or otherwise disrupt, damage, limit or interfere with the proper function of any software, hardware, or telecommunications equipment or to damage or obtain unauthorized access to any system, data, password or other information of Beam Health or any third party (except where such upload, post or submission is made for the purpose of using the Services to generate Sample Data from such uploaded, posted or submitted material); or (e) impersonates any person or entity, including any employee or representative of Beam Health.
\nCompliance with Laws. Development User is responsible for all activity it undertakes in connection with the Services. Development User will use the Services in compliance with all applicable local, state, national and foreign laws, treaties and regulations.
\nReceived Data. Development User will not (i) input into the Services or Development Software any data concerning actual persons (including protected health information and personally identifiable information), (ii) use any Sample Data, data or other information received from Beam Health or the Services, including any derivatives and any aggregated or modified versions of such Sample Data, data or other information, (collectively, the \"Received Data\") for any purpose other than Development Purposes, or (iii) disclose any Received Data to any third party without the express written permission of Beam Health.
\nTerm; Termination
\nTerm. These Terms, and the permissions granted to Development User in Section 1, shall continue until terminated in accordance with Section 5.2 (the \"Term\").
\nTermination. Beam Health may immediately terminate these Terms, in whole or in part, for any reason or no reason. Development User may terminate these Terms at any time by: (a) deleting its account; (b) destroying all copies of the Development Software in Development User's possession or control; and (c) ceasing all use of the Services.
\nEffect of Termination. Upon termination or expiration of these Terms, all rights and licenses granted to Development User hereunder shall immediately cease and Development User shall immediately remove all copies of the Development Software on computer systems under its control. The following sections shall survive any expiration or termination of these Terms: Sections 3, 4, 5.3, 6, 7, 8, 9, 10 and 11.
\nIndemnification
\nDevelopment User shall defend, indemnify, and hold harmless Beam Health, its affiliates and each of its and its affiliates' shareholders, officers, directors, employees, contractors, agents, partners, suppliers, representatives, licensors and content providers (collectively, the \"Beam Health Indemnitees\") from all liabilities, claims, and expenses (including reasonable attorneys' fees and costs), that arise from or relate to (i) the Development User Applications, information submitted by Development User to the API, or Development User's use or misuse of, or access to, the Services, Development Software, or Sample Data (including, without limitation, Development User's submission of data that is subject to HIPAA in violation of these Terms), (ii) a breach or alleged breach of these Terms by Development User, or (iii) alleged infringement by Development User or the Development User Applications of any intellectual property or other right of any person or entity. Beam Health reserves the right to assume the exclusive defense and control of any matter otherwise subject to indemnification by Development User, in which event Development User shall assist and cooperate with Beam Health in asserting any available defenses.
\nTO THE FULLEST EXTENT PERMITTED BY APPLICABLE LAW, THE SERVICES (INCLUDING, WITHOUT LIMITATION, ANY CONTENT), THE SAMPLE DATA AND THE DEVELOPMENT SOFTWARE ARE PROVIDED \"AS IS\" AND \"AS AVAILABLE\" AND ARE WITHOUT REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, STATUTORY OR OTHERWISE INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, TITLE AND FITNESS FOR A PARTICULAR PURPOSE, ANY WARRANTIES IMPLIED BY ANY COURSE OF PERFORMANCE, USAGE OF TRADE, OR COURSE OF DEALING, AND ANY WARRANTY OF CONTINUOUS, UNINTERRUPTED OR ERROR-FREE OPERATION ALL OF WHICH ARE EXPRESSLY DISCLAIMED. TO THE FULLEST EXTENT PERMITTED BY APPLICABLE LAW, BEAM HEALTH AND ITS AFFILIATES, SHAREHOLDERS, OFFICERS, DIRECTORS, EMPLOYEES, CONTRACTORS, AGENTS, PARTNERS, SUPPLIERS, REPRESENTATIVES, LICENSORS AND CONTENT PROVIDERS DO NOT WARRANT THAT: (A) THE SERVICES, SAMPLE DATA AND DEVELOPMENT SOFTWARE WILL BE SECURE OR AVAILABLE AT ANY PARTICULAR TIME OR LOCATION; (B) ANY DEFECTS OR ERRORS WILL BE CORRECTED; (C) ANY CONTENT OR SOFTWARE AVAILABLE THROUGH THE SERVICES, THE SAMPLE DATA OR THE DEVELOPMENT SOFTWARE IS FREE OF VIRUSES OR OTHER HARMFUL COMPONENTS; OR (D) THE RESULTS OF USING THE SERVICES, THE SAMPLE DATA OR THE DEVELOPMENT SOFTWARE WILL BE ACCURATE, WILL BE FREE OF MALWARE, AND/OR MEET DEVELOPMENT USER'S REQUIREMENTS. TO THE FULLEST EXTENT PERMITTED BY APPLICABLE LAW, ANY USE OF THE SERVICES, THE SAMPLE DATA AND THE DEVELOPMENT SOFTWARE IS SOLELY AT DEVELOPMENT USER'S OWN RISK. NOTWITHSTANDING THE FORGOING BEAM HEALTH DOES NOT DISCLAIM ANY WARRANTY OR OTHER RIGHT THAT BEAM HEALTH IS PROHIBITED FROM DISCLAIMING UNDER APPLICABLE LAW.
\nTO THE FULLEST EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL BEAM HEALTH OR ITS AFFILIATES, SHAREHOLDERS, OFFICERS, DIRECTORS, EMPLOYEES, CONTRACTORS, AGENTS, PARTNERS, SUPPLIERS, REPRESENTATIVE, LICENSORS OR CONTENT PROVIDERS, BE LIABLE UNDER CONTRACT, TORT, STRICT LIABILITY, NEGLIGENCE OR ANY OTHER LEGAL OR EQUITABLE THEORY WITH RESPECT TO THE SUBJECT MATTER OF THESE TERMS (I) FOR ANY LOSS OF PROFITS, COST SAVINGS, DATA, REVENUE OR MACHINE USE, LOSSES CAUSED BY MALWARE, INTERRUPTION OF USE, LOSS OR CORRUPTION OF DATA, FAILURE TO PROVIDE SERVICES OR INFORMATION, INTERRUPTION OF USE, LOSS OR CORRUPTION OR INACCURACY OF DATA, COST OF PROCUREMENT OF SUBSTITUTE GOODS, RIGHTS OR SERVICES, OR SPECIAL, INDIRECT, INCIDENTAL, RELIANCE, PUNITIVE, OR CONSEQUENTIAL DAMAGES OF ANY KIND WHATSOEVER, HOWEVER ARISING, (II) FOR ANY BUGS, VIRUSES, TROJAN HORSES, OR THE LIKE (REGARDLESS OF THE SOURCE OF ORIGINATION), OR (III) FOR ANY DAMAGES IN EXCESS OF (IN THE AGGREGATE) ONE HUNDRED DOLLARS ($100), IN EACH CASE (I) THROUGH (III) EVEN IF BEAM HEALTH HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. TO THE FULLEST EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT SHALL BEAM HEALTH ASSUME LIABILITY FOR DAMAGES, DELAYS OR ANY OTHER ERRORS MADE OR CAUSED BY THIRD PARTIES EVEN IF SUCH THIRD PARTY IS A VENDOR RECOMMENDED BY BEAM HEALTH. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR CONSEQUENTIAL DAMAGES, SO THE ABOVE LIMITATIONS AND EXCLUSIONS MAY NOT APPLY. EACH PROVISION OF THESE TERMS THAT PROVIDES FOR A LIMITATION OF LIABILITY, DISCLAIMER OF WARRANTIES, OR EXCLUSION OF DAMAGES IS INTENDED TO AND DOES ALLOCATE THE RISKS BETWEEN THE PARTIES UNDER THESE TERMS. THIS ALLOCATION IS AN ESSENTIAL ELEMENT OF THE BASIS OF THE BARGAIN BETWEEN THE PARTIES. EACH OF THESE PROVISIONS IS SEVERABLE AND INDEPENDENT OF ALL OTHER PROVISIONS OF THESE TERMS. THE LIMITATIONS IN SECTION 7 AND 8 WILL APPLY EVEN IF ANY LIMITED REMEDY FAILS OF ITS ESSENTIAL PURPOSE.
\nDuring the Term, Beam Health may provide Development User with confidential and/or proprietary materials and information (\"Confidential Information\"). All materials and information provided by Beam Health to Development User and identified at the time of disclosure as \"Confidential\" or bearing a similar legend, and all other information that Development User reasonably should have known was the confidential information of Beam Health given the nature of the data and/or the circumstances surrounding disclosure, shall be considered Confidential Information hereunder; for the avoidance of doubt, all information provided by Beam Health in connection with the Services and Development Software is Confidential Information, including without limitation any credentials used to access the API, all documentation, and these Terms. Development User shall maintain the confidentiality of the Confidential Information and shall not disclose such information to any third party without the prior written consent of Beam Health. Development User shall only use the Confidential Information internally for the purpose of exercising its rights and performing its obligations under these Terms. The obligations in this Section 9 shall not apply to any information that is generally available to the public prior to disclosure. Development User may disclose Confidential Information as required by law or court order; provided that, Development User provides Beam Health with prompt written notice thereof and uses its best efforts to limit disclosure. At any time, upon Beam Health's request, Development User shall return to Beam Health all Confidential Information in its possession, including, without limitation, all copies and extracts thereof.
\nAny notice or communication from one party to the other shall be in writing and either personally delivered or sent via confirmed facsimile, recognized express delivery courier or certified or registered mail, postage prepaid and return receipt requested, addressed to such other party at the address provided by Development User during the sign-up process (in the case of notice to Development User) and 328 Gibraltar Dr, Sunnyvale, CA 94089 (in the case of notice to Beam Health); provided, however, that Beam Health may also provide notice to Development User by email at the email address provided by Development User during the sign-up process. All notices shall be in English and effective upon receipt.
\nMiscellaneous
\nAuthority. Development User represents and warrants to Beam Health that (i) Development User has the right and authority to enter into these Terms, to grant all rights herein granted and to fully perform its obligations hereunder, and (ii) Development User's performance of its obligations under these Terms will not violate the terms of any other agreement to which Development User is a party.
\nModifications. We reserve the right to change these Terms on a going-forward basis at any time. Please check these Terms periodically for changes. If a change to these Terms materially modifies your rights or obligations, you will be required to accept the modified Terms in order to continue to use the Services and Development Software. Material modifications are effective upon your acceptance of the modified Terms. Immaterial modifications are effective upon publication. Except as expressly permitted in this Section 11.2, these Terms may be amended only by a written agreement signed by authorized representatives of the parties to these Terms. Disputes arising under these Terms will be resolved in accordance with the version of these Terms that was in effect at the time the dispute arose.
\nEntire Agreement. These Terms constitute the entire agreement between the parties with regard to the subject matter hereof. These Terms supersede all prior negotiations, understandings or agreements (oral or written) between the parties relating to this subject matter and all past dealing or industry custom. Except as set forth in Section 11.2, No waiver, consent, modification or change to these Terms shall bind either party unless in writing and signed by the party against which enforcement is sought, and then only in the specific instance and for the specific purpose given.
\nForce Majeure. Beam Health shall not be liable for any failure to perform its obligations hereunder where such failure results from any cause beyond Beam Health's reasonable control, including, without limitation, the elements; fire; flood; severe weather; earthquake; vandalism; accidents; sabotage; power failure; denial of service attacks or similar attacks; Internet failure; acts of God and the public enemy; acts of war; acts of terrorism; riots; civil or public disturbances; strikes lock-outs or labor disruptions; or any laws, orders, rules, regulations, acts or restraints of any government or governmental body or authority, civil or military, including the orders and judgments of courts.
\nAssignment. Development User will not transfer or assign these Terms, directly or indirectly, to another person without Beam Health's prior written consent. Any attempted assignment in violation of this Section 11.5 shall be null and void. Subject to the foregoing, these Terms are binding upon Beam Health and Development User and their permitted successors and assignees.
\nNo Third Party Beneficiaries. Except as otherwise expressly provided herein, these Terms are for the benefit of the parties hereto and not for any other person or entity. These Terms shall not provide any non-party with any remedy, claim, liability, reimbursement, claim of action or other right in excess of those existing without reference hereto.
\nRelationship of the Parties. No agency, partnership, joint venture, or employment relationship is created as a result of these Terms and neither party has any authority of any kind to bind the other in any respect.
\nTrademarks. Nothing in these Terms shall be construed to grant to either party any right, title or interest (including, without limitation, any implied license) in or to any trademarks, trade names, service marks, and logos of the other party.
\nGoverning Law. These Terms will be interpreted and construed in accordance with the laws of the State of California and the United States of America, without regard to conflict of law principles. All disputes arising out of these Terms will be subject to the exclusive jurisdiction of the state and federal courts located in Santa Clara County, California, and each party hereby consents to the personal jurisdiction thereof.
\nSeverability. If any provision of these Terms is found invalid or unenforceable, the parties agree to replace the offending provision with an enforceable provision that most nearly achieves the intent and economic effect of the unenforceable provision and all other terms shall remain in full force and effect.
\nInterpretation. The headings of paragraphs and subparagraphs are intended for convenience only and should not be given any effect in construing the contents of the respective paragraphs and subparagraphs. These Terms will be construed and interpreted fairly, in accordance with the plain meaning of their terms and there will be no presumption or inference against the party drafting these Terms in construing or interpreting the same.
\nWaiver. The waiver by either party of any breach or default by the other party of any provision of these Terms shall not be construed as a waiver of any succeeding breach of the same or any other provision, nor shall any delay or omission on the part of either party to exercise or avail itself of any right, power or privilege that it has, or may have hereunder, operate as a waiver of any right, power or privilege by such party.
\nRemedies. Except as specifically provided otherwise, each right and remedy in these Terms is in addition to any other right and remedy, at law or in equity, and the exercise of one right or remedy will not be deemed a waiver of any other right or remedy. The prevailing party shall be entitled to recover from the other its costs, expenses and reasonable attorneys' fees incurred in connection with any action or proceeding to enforce or interpret these Terms or in obtaining and enforcing any judgment or order.
\nAll responses are in JSON format. Generally input may use the application/json, application/x-www-form-urlencoded, or form/multipart content types. The list of objects returned by a GET request to :endpoint is paginated and has the following format:
\nPlain Text
\n{\n \"previous\": URL or null, // URL of the previous page\n \"results\": array of objects, // these results follow the same format as `:endpoint/:id`\n \"next\": URL or null // URL of the next page (same as the requested URL, but with the page query parameter included)\n }\n\nSome endpoints may return a 302 redirect response. Most libraries handle this incorrectly by resending the response with different headers or a different HTTP method. You will need to resend the original request with the right HTTP method and headers to the new \"Location\" specified by the 302 response.
\n","_postman_id":"5526ef33-5742-4b60-8b4c-7067826f051e","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e2928aa5-a00f-4749-8476-97bb8a4a6d77","id":"e2928aa5-a00f-4749-8476-97bb8a4a6d77","name":"Introduction","type":"folder"}}},{"name":"Permissions","item":[],"id":"77e4e76b-0d38-43b7-bbe3-382382797a2d","description":"API access is managed using scopes and permissions. Scopes are granted to an API Application when a user authorizes and permissions are granted by a primary user to other users in their Practice Group. The scopes are granted during the OAuth process, whereas the permissions have to be granted from Beam Health web app. In order for an app to access information on behalf of a Beam Health user, the user must authorize the app for the requested scopes, and the user must have the appropriate permissions set. Each endpoint in this documentation will specify which scopes and permissions are needed for access. Scopes are labeled beamhealth_oauth2 in the AUTHORIZATIONS section of each endpoint.
\n","_postman_id":"77e4e76b-0d38-43b7-bbe3-382382797a2d","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e2928aa5-a00f-4749-8476-97bb8a4a6d77","id":"e2928aa5-a00f-4749-8476-97bb8a4a6d77","name":"Introduction","type":"folder"}}},{"name":"Data Types","item":[],"id":"57dbcb62-a0e5-4271-a664-7787ed056cc7","description":"A numeric value truncated to two decimal places. It may be passed to an endpoint as an integer, float, or string, but will always be returned as a string.
\n","_postman_id":"57dbcb62-a0e5-4271-a664-7787ed056cc7","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e2928aa5-a00f-4749-8476-97bb8a4a6d77","id":"e2928aa5-a00f-4749-8476-97bb8a4a6d77","name":"Introduction","type":"folder"}}},{"name":"Value-Add Services","item":[],"id":"2d3ece86-6e79-4f7d-81b7-336bcdced294","description":"To help drive growth of integrations, Beam Health offers certain value-added services for developers in . These services are not required to develop and deploy production-ready applications.
\nValue-added services currently available:
\nThe above pricing is subject to change; changes will be reflected in the table above. Capacity may be limited. For more information about specific services please reach out to info@beamhealthgroup.com.
\n","_postman_id":"2d3ece86-6e79-4f7d-81b7-336bcdced294","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e2928aa5-a00f-4749-8476-97bb8a4a6d77","id":"e2928aa5-a00f-4749-8476-97bb8a4a6d77","name":"Introduction","type":"folder"}}}],"id":"e2928aa5-a00f-4749-8476-97bb8a4a6d77","description":"This document is intended as a detailed reference for the precise behavior of Beam Health’s API. If this is your first time using the API, start with our tutorial.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"a03333ff-b48f-4747-99cb-335ba4cc40bd","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b6f2ded6-1bd6-4e27-89a5-d2fa5b8c1cb1","type":"text/javascript","exec":[""]}}],"_postman_id":"e2928aa5-a00f-4749-8476-97bb8a4a6d77"},{"name":"Authorization","item":[{"name":"Get Access Token","id":"b80f7619-56d0-4aaa-8c10-8b78f85ab7fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"formdata","formdata":[{"key":"client_id","value":"","description":"YOUR_CLIENT_ID
\n","type":"text"},{"key":"client_secret","value":"","description":"YOUR_CLIENT_SECRET
\n","type":"text"},{"key":"grant_type","value":"client_credentials","type":"text"}]},"url":"https://providers.beam.health/o/token/","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"e16c3c1a-f2b1-4468-82e8-b2f2a0b60729","id":"e16c3c1a-f2b1-4468-82e8-b2f2a0b60729","name":"Authorization","type":"folder"}},"urlObject":{"path":["o","token",""],"host":["https://providers.beam.health"],"query":[],"variable":[]}},"response":[],"_postman_id":"b80f7619-56d0-4aaa-8c10-8b78f85ab7fe"}],"id":"e16c3c1a-f2b1-4468-82e8-b2f2a0b60729","description":"To authorize with our API, you will need to use your unique client credentials. If you don't have one, please reach out to our support team or sign up on our website to get one.
\nEach API request must include an bearer token as a means of identification and access control. This token is associated with your user account, and it grants you the ability to interact with our data in various ways, depending on your level of access.
\nYour client credentials should be kept private at all times. If you believe your client credentials may have been compromised, please contact our support team immediately so we can revoke your old key and issue a new one.
\nYou will make a request to receive your access token using your client ID and secret as shown below. Once you have your token, you can access endpoints by including it in the header like this
\nAuthorization: Bearer YOUR_ACCESS_TOKEN\n\nReturns all patient data for a staff member.
\n","urlObject":{"path":["v1","patients",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"Page number of response (10 responses per page)
\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"Email of specific patient
\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"e76b302b-96e5-4beb-950e-3fcd2ee8d9f5","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Create a new patient in the system
\n","urlObject":{"path":["v1","patients",""],"host":["https://providers.beam.health"],"query":[{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"1675708a-ece3-4064-8438-bec652e4e64b","name":"response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Updates an existing patient in the system by looking up their email
\n","urlObject":{"path":["v1","patients",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Required) Current email of the patient un the system
\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"49f6746f-1acd-42b3-a2eb-7020067722be","name":"response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Deletes an existing patient in the system
\n","urlObject":{"path":["v1","patients",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Required) Email of the patient
\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"fbf294a6-b368-4870-96b3-41d159a6e6a6","name":"response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Documentation for endpoints related to managing patient data.
\n","_postman_id":"619bd604-5777-446e-b48c-88f08a626479","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}}},{"name":"Encounters API","item":[{"name":"Fetch encounter data","id":"475bd50b-a45b-4f60-89b1-7e91ac275149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"https://providers.beam.health/v1/encounters/?patient_email=&start_date=&end_date=&page=","description":"Returns all encounter data for a staff member.
\n","urlObject":{"path":["v1","encounters",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Optional) Email of the patient for getting encounters specific to them
\n","type":"text/plain"},"key":"patient_email","value":""},{"description":{"content":"(Optional) Start date of the range to retrieve encounters (yyyy-mm-dd)
\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"(Optional) End date of the range to retrieve encounters (yyyy-mm-dd)
\n","type":"text/plain"},"key":"end_date","value":""},{"description":{"content":"Page number of response (10 responses per page)
\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"dd4315ab-abdb-444e-80b1-ee2273f6c359","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Updates notes for a specific encounter.
\n","urlObject":{"path":["v1","encounters",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Required) Unique ID of the encounter
\n","type":"text/plain"},"key":"encounter_id","value":""},{"description":{"content":"(Optional) Subjective notes for the encounter
\n","type":"text/plain"},"key":"subjective_notes","value":""},{"description":{"content":"(Optional) Objective notes for the encounter
\n","type":"text/plain"},"key":"objective_notes","value":""},{"description":{"content":"(Optional) Assessment notes for the encounter
\n","type":"text/plain"},"key":"assessment_notes","value":""},{"description":{"content":"(Optional) Plan notes for the encounter
\n","type":"text/plain"},"key":"plan_notes","value":null}],"variable":[]}},"response":[{"id":"5190289f-8675-4eff-a47e-05afe59bbc2e","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Documentation for endpoints related to managing encounter data.
\n","_postman_id":"ff2bf627-375d-4e3f-b976-4682608e6452","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}}},{"name":"Payments API","item":[{"name":"Fetch invoice data","id":"7b1eb954-88fa-4560-b257-a7eb70ab9747","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"GET","header":[],"url":"https://providers.beam.health/v1/payments/?patient_email=&start_date=&end_date=&page=","description":"Returns all invoice data for a staff member.
\n","urlObject":{"path":["v1","payments",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Optional) Email of the patient for getting invoices specific to them
\n","type":"text/plain"},"key":"patient_email","value":""},{"description":{"content":"(Optional) Start date of the range to retrieve invoices (yyyy-mm-dd)
\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"(Optional) End date of the range to retrieve invoices (yyyy-mm-dd)
\n","type":"text/plain"},"key":"end_date","value":""},{"description":{"content":"Page number of response (10 responses per page)
\n","type":"text/plain"},"key":"page","value":""}],"variable":[]}},"response":[{"id":"69b3cdf6-da57-4cd2-a2eb-9f35a94d8a10","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Updates invoice notes for a specific charge.
\n","urlObject":{"path":["v1","encounters",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Required) Unique ID of the encounter
\n","type":"text/plain"},"key":"encounter_id","value":""},{"description":{"content":"(Optional) Subjective notes for the encounter
\n","type":"text/plain"},"key":"subjective_notes","value":""},{"description":{"content":"(Optional) Objective notes for the encounter
\n","type":"text/plain"},"key":"objective_notes","value":""},{"description":{"content":"(Optional) Assessment notes for the encounter
\n","type":"text/plain"},"key":"assessment_notes","value":""},{"description":{"content":"(Optional) Plan notes for the encounter
\n","type":"text/plain"},"key":"plan_notes","value":null}],"variable":[]}},"response":[{"id":"5446ce9c-b10e-40e3-8618-13c288279931","name":"response","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":"Documentation for endpoints related to managing payment data.
\n","_postman_id":"02556e30-e056-480d-97b4-74d1f3434231","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}}},{"name":"Appointments API","item":[{"name":"Fetch appointments","id":"ad17e714-4f4c-4ff5-bb8b-c9eb0132f7ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://providers.beam.health/v1/appointments/?staff_id=&practice_id=&patient_email=&start_date=&end_date=","description":"Returns all appointment data for a staff member.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}},"urlObject":{"path":["v1","appointments",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Required) Unique ID of the staff member
\n","type":"text/plain"},"key":"staff_id","value":""},{"description":{"content":"(Required) Unique ID of the staff practice
\n","type":"text/plain"},"key":"practice_id","value":""},{"description":{"content":"(Optional) Email of the patient for getting appointments specific to them
\n","type":"text/plain"},"key":"patient_email","value":""},{"description":{"content":"(Optional) Start date of the range to retrieve appointments (yyyy-mm-dd)
\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"(Optional) End date of the range to retrieve appointments (yyyy-mm-dd)
\n","type":"text/plain"},"key":"end_date","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"86031338-7f01-4877-9f69-3348552b6f38","name":"response","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://providers.beam.health/v1/appointments/?staff_id=&practice_id=&patient_email=&start_date=&end_date=","host":["https://providers.beam.health"],"path":["v1","appointments",""],"query":[{"key":"staff_id","value":"","description":"(Required) Unique ID of the staff member"},{"key":"practice_id","value":"","description":"(Required) Unique ID of the staff practice\n\n"},{"key":"patient_email","value":"","description":"(Optional) Email of the patient for getting appointments specific to them\n\n"},{"key":"start_date","value":"","description":"(Optional) Start date of the range to retrieve appointments (yyyy-mm-dd)"},{"key":"end_date","value":"","description":"(Optional) End date of the range to retrieve appointments (yyyy-mm-dd)"},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 100,\n \"date\": \"2022-08-20\",\n \"start_time\": 1661259158,\n \"end_time\": 1661260158,\n \"duration\": 60,\n \"patient_name\": \"John Appleseed\",\n \"patient_email\": \"j_appleseed@beamhealthgroup.com\",\n \"practice\": \"Beam Clinic\",\n \"staff\": \"Beam Staff\",\n \"notes\": \"Telehealth consult\",\n \"status\": \"Booked\"\n}"}],"_postman_id":"ad17e714-4f4c-4ff5-bb8b-c9eb0132f7ec"},{"name":"Create an appointment","id":"e0ed82fa-449d-4d8d-891d-2412b87c71b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"j_appleseed@beamhealthgroup.com\"\n \"start_time\": 1661259158,\n \"end_time\": 1661260158,\n \"notes\": \"Telehealth consult\"\n}"},"url":"https://providers.beam.health/v1/appointments/?staff_id=&practice_id=","description":"Creates an appointment under the staff member.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}},"urlObject":{"path":["v1","appointments",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Required) Unique ID of the staff member
\n","type":"text/plain"},"key":"staff_id","value":""},{"description":{"content":"(Required) Unique ID of the staff practice
\n","type":"text/plain"},"key":"practice_id","value":""},{"disabled":true,"description":{"content":"","type":"text/plain"},"key":"","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"b8b7bfe3-78fc-4cc6-af14-38d5fb88061c","name":"response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"j_appleseed@beamhealthgroup.com\"\n \"start_time\": 1661259158,\n \"end_time\": 1661260158,\n \"notes\": \"Telehealth consult\"\n}"},"url":{"raw":"https://providers.beam.health/v1/appointments/?staff_id=&practice_id=","host":["https://providers.beam.health"],"path":["v1","appointments",""],"query":[{"key":"staff_id","value":"","description":"(Required) Unique ID of the staff member"},{"key":"practice_id","value":"","description":"(Required) Unique ID of the staff practice\n\n"},{"key":"","value":"","description":"\n","disabled":true},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 100,\n \"date\": \"2022-08-20\",\n \"start_time\": 1661259158,\n \"end_time\": 1661260158,\n \"duration\": 60,\n \"patient_name\": \"John Appleseed\",\n \"patient_email\": \"j_appleseed@beamhealthgroup.com\",\n \"practice\": \"Beam Clinic\",\n \"staff\": \"Beam Staff\",\n \"notes\": \"Telehealth consult\",\n \"status\": \"Booked\"\n}"}],"_postman_id":"e0ed82fa-449d-4d8d-891d-2412b87c71b2"},{"name":"Update an existing appointment","id":"f54e45dd-9c46-406c-aa9c-8f9df1edc706","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"j_appleseed@beamhealthgroup.com\"\n \"start_time\": 1661259158,\n \"end_time\": 1661260158,\n \"notes\": \"Telehealth consult\"\n}"},"url":"https://providers.beam.health/v1/appointments/?staff_id=&practice_id=&appointment_id=","description":"Updates an existing appointment.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}},"urlObject":{"path":["v1","appointments",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Required) Unique ID of the staff member
\n","type":"text/plain"},"key":"staff_id","value":""},{"description":{"content":"(Required) Unique ID of the staff practice
\n","type":"text/plain"},"key":"practice_id","value":""},{"description":{"content":"(Required) Unique ID of the appointment slot
\n","type":"text/plain"},"key":"appointment_id","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"a7bfe89f-dacd-4c82-889c-4cc3226871a1","name":"response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"j_appleseed@beamhealthgroup.com\"\n \"start_time\": 1661259158,\n \"end_time\": 1661260158,\n \"notes\": \"Telehealth consult\"\n}"},"url":{"raw":"https://providers.beam.health/v1/appointments/?staff_id=&practice_id=","host":["https://providers.beam.health"],"path":["v1","appointments",""],"query":[{"key":"staff_id","value":"","description":"(Required) Unique ID of the staff member"},{"key":"practice_id","value":"","description":"(Required) Unique ID of the staff practice\n\n"},{"key":"","value":"","description":"\n","disabled":true},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 100,\n \"date\": \"2022-08-20\",\n \"start_time\": 1661259158,\n \"end_time\": 1661260158,\n \"duration\": 60,\n \"patient_name\": \"John Appleseed\",\n \"patient_email\": \"j_appleseed@beamhealthgroup.com\",\n \"practice\": \"Beam Clinic\",\n \"staff\": \"Beam Staff\",\n \"notes\": \"Telehealth consult\",\n \"status\": \"Booked\"\n}"}],"_postman_id":"f54e45dd-9c46-406c-aa9c-8f9df1edc706"},{"name":"Delete an appointment","id":"a786e8bd-82a9-48d7-9275-c0e4ac6bf8e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"j_appleseed@beamhealthgroup.com\"\n \"start_time\": 1661259158,\n \"end_time\": 1661260158,\n \"notes\": \"Telehealth consult\"\n}"},"url":"https://providers.beam.health/v1/appointments/?staff_id=&practice_id=&appointment_id=","description":"Deletes an appointment from the schedule.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}},"urlObject":{"path":["v1","appointments",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Required) Unique ID of the staff member
\n","type":"text/plain"},"key":"staff_id","value":""},{"description":{"content":"(Required) Unique ID of the staff practice
\n","type":"text/plain"},"key":"practice_id","value":""},{"description":{"content":"(Required) Unique ID of the appointment slot
\n","type":"text/plain"},"key":"appointment_id","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"fb0820fa-5788-4292-af9c-fbb5cae05193","name":"response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\":\"j_appleseed@beamhealthgroup.com\"\n \"start_time\": 1661259158,\n \"end_time\": 1661260158,\n \"notes\": \"Telehealth consult\"\n}"},"url":{"raw":"https://providers.beam.health/v1/appointments/?staff_id=&practice_id=&appointment_id=","host":["https://providers.beam.health"],"path":["v1","appointments",""],"query":[{"key":"staff_id","value":"","description":"(Required) Unique ID of the staff member"},{"key":"practice_id","value":"","description":"(Required) Unique ID of the staff practice\n\n"},{"key":"appointment_id","value":"","description":"(Required) Unique ID of the appointment slot"},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"\"Appointment slot deleted\""}],"_postman_id":"a786e8bd-82a9-48d7-9275-c0e4ac6bf8e9"}],"id":"8e7049d0-d4bd-4887-ae1d-67fb37172471","description":"Documentation for endpoints related to managing appointment data.
\n","_postman_id":"8e7049d0-d4bd-4887-ae1d-67fb37172471","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}}},{"name":"Intake API","item":[{"name":"Create Intake Form","id":"3798a1f9-1f73-48e1-9a24-6033d954c1a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"questions\": [\n {\n \"type\": \"text\", \n \"title\": \"How do you feel?\", \n \"required\": true\n }, {\n \"type\": \"multiple-choice\", \n \"title\": \"Which of the symptoms do you have? (select all that apply)\", \n \"values\": [\"Fever\", \"Cough\", \"Cold\", \"Body Pain\"], \n \"required\": true\n }, {\n \"type\": \"dropdown\", \n \"title\": \"Have you visited us before?\", \n \"values\": [\"Yes\", \"No\", \"Don't remember\"], \n \"required\": true\n }\n ],\n \"form_type\": \"Pre Check In\",\n \"form_title\": \"My Intake Form\",\n \"form_description\": \"Intake form for patients.\"\n}"},"url":"https://providers.beam.health/v1/intake/?staff_id&practice_id","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}},"urlObject":{"path":["v1","intake",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Required) Unique ID of the staff member
\n","type":"text/plain"},"key":"staff_id","value":null},{"description":{"content":"(Required) Unique ID of the staff practice
\n","type":"text/plain"},"key":"practice_id","value":null}],"variable":[]}},"response":[{"id":"7c5b0c99-5e63-4fb8-b5cf-2ff4a2160615","name":"response","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"questions\": [\n {\n \"type\": \"text\", \n \"title\": \"How do you feel?\", \n \"required\": true\n }, {\n \"type\": \"multiple-choice\", \n \"title\": \"Which of the symptoms do you have? (select all that apply)\", \n \"values\": [\"Fever\", \"Cough\", \"Cold\", \"Body Pain\"], \n \"required\": true\n }, {\n \"type\": \"dropdown\", \n \"title\": \"Have you visited us before?\", \n \"values\": [\"Yes\", \"No\", \"Don't remember\"], \n \"required\": true\n }\n ],\n \"form_type\": \"Pre Check In\",\n \"form_title\": \"My Intake Form\",\n \"form_description\": \"Intake form for patients.\"\n}"},"url":{"raw":"https://providers.beam.health/v1/intake/?staff_id&practice_id","host":["https://providers.beam.health"],"path":["v1","intake",""],"query":[{"key":"staff_id","value":null,"description":"(Required) Unique ID of the staff member"},{"key":"practice_id","value":null,"description":"(Required) Unique ID of the staff practice"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 100,\n \"creator\": \"Beam Staff\",\n \"questions\": [\n {\n \"type\": \"text\", \n \"title\": \"How do you feel?\", \n \"required\": true\n }, {\n \"type\": \"multiple-choice\", \n \"title\": \"Which of the symptoms do you have? (select all that apply)\", \n \"values\": [\"Fever\", \"Cough\", \"Cold\", \"Body Pain\"], \n \"required\": true\n }, {\n \"type\": \"dropdown\", \n \"title\": \"Have you visited us before?\", \n \"values\": [\"Yes\", \"No\", \"Don't remember\"], \n \"required\": true\n }\n ],\n \"form_type\": \"Pre Check In\",\n \"form_title\": \"My Intake Form\",\n \"form_description\": \"Intake form for patients.\"\n}"}],"_postman_id":"3798a1f9-1f73-48e1-9a24-6033d954c1a2"},{"name":"Fetch intake responses","id":"1298778b-4b27-4b20-a227-a390622ada87","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://providers.beam.health/v1/intake/responses/?staff_id&practice_id&form_id","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}},"urlObject":{"path":["v1","intake","responses",""],"host":["https://providers.beam.health"],"query":[{"description":{"content":"(Required) Unique ID of the staff member
\n","type":"text/plain"},"key":"staff_id","value":null},{"description":{"content":"(Required) Unique ID of the staff practice
\n","type":"text/plain"},"key":"practice_id","value":null},{"description":{"content":"(Required) Unique ID of the form
\n","type":"text/plain"},"key":"form_id","value":null}],"variable":[]}},"response":[{"id":"771cbd31-78bc-4381-bd5a-452f5e9b40b4","name":"response","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"id\": 100,\n \"title\": \"My Intake Form\", \n \"responses\": [\n \"patient_name\": \"John Appleseed\",\n \"patient_email\": \"j_appleseed@beamhealthgroup.com\",\n {\n \"type\": \"text\", \n \"title\": \"How do you feel?\", \n \"values\": \"Feeling like I have the flu\", \n \"required\": true\n }, {\n \"type\": \"multiple-choice\", \n \"title\": \"Which of the symptoms do you have? (select all that apply)\", \n \"values\": [\"Fever\", \"Cough\", \"Body Pain\"], \n \"required\": true\n }, {\n \"type\": \"dropdown\", \n \"title\": \"Have you visited us before?\", \n \"values\": [\"No\"], \n \"required\": true\n }\n ], \n [\n \"patient_name\": \"Jane Appleseed\",\n \"patient_email\": \"jane_appleseed@beamhealthgroup.com\",\n {\n \"type\": \"text\", \n \"title\": \"How do you feel?\", \n \"values\": \"Feeling ok, just checking in.\", \n \"required\": true\n }, {\n \"type\": \"multiple-choice\", \n \"title\": \"Which of the symptoms do you have? (select all that apply)\", \n \"values\": [], \n \"required\": true\n }, {\n \"type\": \"dropdown\", \n \"title\": \"Have you visited us before?\", \n \"values\": [\"Yes\"], \n \"required\": true\n }\n ], \n \"description\": \"Form for patients\"\n}"}],"_postman_id":"1298778b-4b27-4b20-a227-a390622ada87"}],"id":"98830a8e-2e31-4a6d-85bf-f5610561b150","description":"Documentation for endpoints related to managing patient intake data.
\n","_postman_id":"98830a8e-2e31-4a6d-85bf-f5610561b150","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}}},{"name":"Webhooks","item":[],"id":"bf64f762-1e89-4c70-b4e7-156640d83dca","description":"Callback URL Callback URl is used to receive all hooks when subscribed events are triggered. This should be an URL under your control.
\nEvents Events are used to register events you want to receiver notification when they happen. Currently we support following events.
\n","_postman_id":"bf64f762-1e89-4c70-b4e7-156640d83dca","auth":{"type":"apikey","apikey":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","id":"21f2eb5c-2075-4d5d-a175-15b3bb54cd25","name":"Beam Health API v2.0","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[]}},"event":[{"listen":"prerequest","script":{"id":"6852e00c-d7ea-487d-be46-6fc1e92f535a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ce7d193b-1315-403c-9692-bb7ed6508e6a","type":"text/javascript","exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://providers.beam.health","type":"string"},{"key":"Info client ID","value":"oODhHyOYdyAgbFDpBDlb85Co5NMpnrGY2ItBtVGQ"},{"key":"Access Token URL","value":"https://providers.beam.health/o/token/"},{"key":"Authorization URL","value":"https://providers.beam.health/o/authorize"},{"key":"Info client secret","value":"UPrbSldodelHcpt3RkqH1XdCanUb1c66ROdXxI9X5tbKCVlm49M2NpSu8FBXQcA12JkO391UrS3JbrJaGecLPVaYJP4sVI55mpLCdCeDuusbWdKNbFqSEsSwF2AnKDrb"}]}