Summary / When to Use This
Use OnRamp’s Widget API when you want the same data shown in your embedded widget—delivered as JSON. This is useful if you want to build a custom display, power a dashboard, or send data into another system.
Before You Begin
Make sure you have:
Org ID – Find it in Settings → Widget → Script (inside the embed code snippet).
Customer user’s email – The email must belong to a customer user who is shared on an active project in your org.
Firewall access – Outbound requests to
https://app.onramp.usmust be allowed.
Steps to Follow
1. Know the Method and Endpoint
Method:
GETEndpoint:
https://app.onramp.us/api/widget/data
2. Include Required Query Parameters
org_id(string, required) — Your Org ID from the widget script.email(string, required) — Email of a customer user on an active project.
Example URL:
https://app.onramp.us/api/widget/data?org_id=ORG_ID_HERE&email=EMAIL_HERE
3. Test in Your Browser
Paste the URL into your browser with your values.
If valid, you’ll see a
200response with JSON.If invalid, you’ll see a
400error.
4. Test with cURL (Optional)
curl -X GET \ "https://app.onramp.us/api/widget/data?org_id=ef7209a4-600d-46d2-bbd6-c41128513100&email=example@onramp.us"
5. Use in Postman (Optional)
Method: GET
URL:
https://app.onramp.us/api/widget/dataParams:
org_id= your Org IDemail= active customer user’s email
Click Send to preview the response.
Expected Responses
Success (200)
{ "status": 200, "success": true, "message": "widget data", "data": { "email": "example@onramp.us", "org_id": "ef7209a4-600d-46d2-bbd6-c41128513100", "customer_logo": "http://app.onramp.us/static/img/logos/cb9cca9d.png", "project_link": "https://app.onramp.us/portal/project/WYxk8mepY2aMy", "project_name": "example project", "start_date": "2023-07-12 00:03:00", "end_date": "2023-08-13 00:03:00", "percent_complete": "0", "days_remaining": "-94" } }Error (400)
{ "status": 400, "success": false, "message": "There is a problem with the customer", "data": {} }Common reasons:
org_idis missing or invalidemailis not a customer user in your orgThe user isn’t shared on an active project
Tips & Troubleshooting
No Data / 400 Error: Confirm the email belongs to a customer user on an active project.
Org ID Not Working: Re-copy it from Settings → Widget → Script and check for extra spaces.
CORS / Network Errors: Ensure your app/network allows requests to
https://app.onramp.us.
Parsing Dates and Numbers:
Dates are strings in
YYYY-MM-DD HH:mm:ssformatpercent_completeanddays_remainingmay come as strings—convert to numbers if needed.
Rate/Access Considerations: This endpoint is designed for per-user fetches, not bulk exports. For org-wide reporting, use OnRamp’s Export features instead.