Use the OnRamp Widget API

Last updated: March 13, 2026

The OnRamp Widget API lets you retrieve live project data for a specific customer user as JSON — useful for building custom dashboards, powering embedded displays, or feeding project status into other systems.

Before You Begin

You’ll need three things:

  • Org ID — Find it in Settings › Widget › Script inside the embed code snippet.
  • Customer user’s email — Must belong to a customer user who is a member of an active project in your org.
  • Firewall access — Outbound requests to https://app.onramp.us must be allowed from your environment.

Endpoint

  • Method: GET
  • URL: https://app.onramp.us/api/widget/data

Required Query Parameters

  • org_id — Your Org ID from the widget script
  • email — Email of a customer user on an active project

Example URL:

https://app.onramp.us/api/widget/data?org_id=YOUR_ORG_ID&email=customer@example.com

Testing the Endpoint

In your browser

Paste the URL with your values. A valid request returns a 200 response with JSON. An invalid request returns a 400 error.

With cURL

curl -X GET "https://app.onramp.us/api/widget/data?org_id=YOUR_ORG_ID&email=customer@example.com"

In Postman

  1. Set method to GET, URL to https://app.onramp.us/api/widget/data.
  2. Add org_id and email as query params.
  3. Click Send.

Response Examples

Success (200)

{
  "status": 200,
  "success": true,
  "message": "widget data",
  "data": {
    "email": "customer@example.com",
    "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": "Acme Onboarding",
    "start_date": "2023-07-12 00:03:00",
    "end_date": "2023-08-13 00:03:00",
    "percent_complete": "0",
    "days_remaining": "32"
  }
}

Error (400)

{
  "status": 400,
  "success": false,
  "message": "There is a problem with the customer",
  "data": {}
}

Common causes: org_id is missing or invalid, the email isn’t a customer user in your org, or the user isn’t on an active project.

Tips & Troubleshooting

  • 400 error? Confirm the email belongs to a customer user who is currently a member of an active project.
  • Org ID not working? Re-copy it from Settings › Widget › Script and check for trailing spaces.
  • CORS or network errors? Ensure your app allows outbound requests to https://app.onramp.us.
  • Parsing dates and numbers: Dates are strings in YYYY-MM-DD HH:mm:ss format. percent_complete and days_remaining may return as strings — cast them to numbers if needed.
  • Not for bulk exports: This endpoint is designed for per-user fetches. For org-wide data, use OnRamp’s Export features instead.