Use the OnRamp API to Access and Manage Your Data

Summary / When to Use This

The OnRamp API lets you securely access and update data from your OnRamp instance. You can use it to automate onboarding workflows, sync information with external systems like Salesforce or HubSpot, or build your own integrations.

The API follows modern REST standards, supports JSON for all requests and responses, and uses standard HTTP verbs like GET, POST, PUT, and DELETE.

🔗 Always check the latest version:
New endpoints are added regularly. For the most current documentation, visit https://api.onramp.us/docs

Before You Begin

Make sure:

The API is enabled for your organization. If it’s not, contact your OnRamp Account Manager.
You have generated an authentication token — required for every request.
You understand basic REST and JSON conventions.

API Overview

The OnRamp API allows you to:

Retrieve data about projects, playbooks, customers, and more.
Create and update records directly from external systems.
Automate repetitive tasks like tagging, completing, or archiving.
Listen for events via webhooks for real-time sync.

All responses are UTF-8 encoded JSON objects, and standard HTTP status codes indicate request results.

Rate Limits

To maintain reliability, OnRamp enforces usage limits:

Read operations: up to 600 per minute
Write operations: up to 200 per minute

If you exceed these limits, you’ll receive a 429 Too Many Requests response.
You may also encounter concurrency limits if too many simultaneous requests are active.

Each API request includes a unique Request ID (X-Request-Id in the response header). If you need support, include this value when contacting support@onramp.us.

URL Structure

OnRamp endpoints follow predictable, RESTful patterns:

Type	Example	Description
`/v1/resource`	`GET https://api.onramp.us/v1/users`	List or create resources
`/v1/resource/{id}`	`GET https://api.onramp.us/v1/tasks/{task_id}`	Retrieve or update a specific record
`/v1/resource/{id}/action`	`POST https://api.onramp.us/v1/projects/{project_id}/archive`	Perform an action on a resource

Common Endpoints

Here’s a quick reference of key API groups and their most common endpoints.

🧑‍💼 Customers

GET /v1/customers — Get all customers
POST /v1/customers — Create a new customer
GET /v1/customers/{customer_id} — Get customer by ID
PUT /v1/customers/{customer_id} — Update customer
POST /v1/customers/{customer_id}/tag/{tag_id} — Add a tag
DELETE /v1/customers/{customer_id}/tag/{tag_id} — Remove a tag

📅 Projects

GET /v1/projects — Get all projects
POST /v1/projects — Create a new project
GET /v1/projects/{project_id} — Get project by ID
PUT /v1/projects/{project_id} — Update project
GET /v1/projects/{project_uuid}/members — List project members
POST /v1/projects/{project_id}/tag/{tag_id} — Add a tag
DELETE /v1/projects/{project_id}/tag/{tag_id} — Remove a tag

🧩 Modules

GET /v1/modules — Get all modules
GET /v1/modules/{module_id} — Get module by ID
PUT /v1/modules/{module_id} — Update module

🪄 Playbooks

GET /v1/playbooks — Get all playbooks

✅ Tasks

GET /v1/tasks — Get all tasks
POST /v1/tasks — Create a new task
GET /v1/tasks/{task_id} — Get task by ID
PUT /v1/tasks/{task_id} — Update task
POST /v1/tasks/{task_id}/complete — Mark task complete
POST /v1/tasks/{task_id}/tag/{tag_id} — Add a tag
DELETE /v1/tasks/{task_id}/tag/{tag_id} — Remove a tag

👥 Users & Roles

GET /v1/users — Get all users
POST /v1/users — Create a new user
GET /v1/users/{user_id} — Get user by ID
PUT /v1/users/{user_id} — Update user
GET /v1/user-roles — List all user roles

🏷️ Tags & Statuses

GET /v1/tags — List tags
POST /v1/tags — Create a tag
PUT /v1/tags/{tag_id} — Update a tag
DELETE /v1/tags/{tag_id} — Delete a tag
GET /v1/statuses — Get all statuses

🔔 Webhooks

GET /v1/webhooks — List webhooks
POST /v1/webhooks — Create a new webhook
GET /v1/webhooks/{webhook_id} — Get webhook by ID

📊 Data Fields & Values

GET /v1/datafields — Get all data fields
PUT /v1/datafields/{datafield_uuid} — Update data field
GET /v1/datafields/{datafield_uuid}/values — Get all values for a data field
GET /v1/datafield-values/{datafield_value_uuid} — Get datafield value by UUID
PUT /v1/datafield-values/{datafield_value_uuid} — Update datafield value

Tips & Troubleshooting

💡 Best Practices

Use pagination and filtering to optimize performance.
Cache frequent reads when possible to minimize load.
Respect rate limits and retry with exponential backoff.
Log and store X-Request-Id values for troubleshooting.
Validate webhook signatures for authenticity.

🛠️ Common Issues

401 Unauthorized: Check your authentication token.
429 Too Many Requests: You’ve exceeded rate limits — add retry logic.
404 Not Found: Verify that the resource ID exists and is accessible.