OnboardingHub OnboardingHub

API Overview

The OnboardingHub API is a RESTful JSON API that lets you programmatically manage contacts, organisations, enrollments, guides, and webhook endpoints within your workspace.

Base URL

All API endpoints are available at:

https://onboarding-hub.com/api/v1/

Authentication

Every request must include an Authorization header with a Bearer token:

Authorization: Bearer YOUR_ACCESS_TOKEN

Tokens can be obtained in two ways:

Quick start

Here is how to list your contacts with curl:

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  https://onboarding-hub.com/api/v1/contacts

Available endpoints

Resource Operations Scope
Contacts List, Get, Create, Update, Delete, Search contacts:read, contacts:write
Organisations List, Get, Create, Update, Delete organisations:read, organisations:write
Enrollments List, Get, Create, Update, Delete enrollments:read, enrollments:write
Guides List, Get (read-only) guides:read
Webhook Endpoints List, Get, Create, Update, Delete, Test webhooks:manage

Interactive reference

Explore the full API specification with request/response examples in the interactive API reference.

Rate limits

All authenticated API requests are rate-limited:

  • 60 requests per minute per token
  • 500 requests per hour per token

See Rate Limiting for details on headers and handling 429 responses.

SDKs and integrations

  • Zapier -- connect OnboardingHub to thousands of apps. See Zapier Integration.
  • MCP -- let AI assistants manage your workspace. See MCP Integration.
  • Webhooks -- receive real-time notifications when events happen. See Webhooks.

Next steps