Getting Started
Steps to get running with the Onboard API quickly.
1. Set up Base URL and auth
Use the production API base URL:
https://rest.onboard.io
Generate or copy your API key in Onboard under Company settings → API key (you must be signed in as a user who can manage company settings). Send it on every request as described in Authentication.
If your contract uses a different API host, email [email protected] for the correct base URL.
See also the Security checklist.
2. Test an endpoint
Start with a read-only endpoint to validate credentials and permissions.
A reliable first call is GET /account/, which returns your company (organization) record and related metadata for the API key you used:
curl -sS -X GET "https://rest.onboard.io/account/" \
-H "Authorization: Token YOUR_API_KEY"A successful response is a single JSON object (shape varies by product configuration). Below is an anonymized example with representative fields; production payloads include a large settings object with many feature flags and limits.
{
"id": 10001,
"company_name": "Example Co",
"slug": "example-co",
"domain": "example.com",
"uuid": "00000000-0000-4000-8000-000000000001",
"is_active": true,
"settings": {
"workflow_limit": 50,
"team_member_limit": 5,
"map_types_limit": 100,
"created_at": "2022-11-01T14:38:22Z",
"modified_at": "2026-04-29T21:45:31Z",
"background_color": "#FBFBFB",
"button_color": "#3E61F4",
"workflows_enabled": true,
"date_format": "yyyy-MM-dd",
"short_date_format": "MM/dd",
"time_format": "h:mm:ss a"
},
"outboard_logo": "https://cdn.example.com/assets/example/outboard-logo.webp",
"avatar": "https://cdn.example.com/assets/example/avatar.jpeg",
"logos": [
{
"id": 501,
"created_at": "2026-03-20T20:22:49Z",
"modified_at": "2026-03-26T18:35:18Z",
"image": "https://cdn.example.com/assets/example/logo.jpeg",
"thumbnail": "https://cdn.example.com/assets/example/logo.thumbnail.jpeg",
"medium": "https://cdn.example.com/assets/example/logo.medium.jpeg",
"large": "https://cdn.example.com/assets/example/logo.large.jpeg"
}
],
"is_ai_enabled": true,
"default_api_key": "0000000000000000000000000000000000000000",
"created_at": "2026-04-13T18:12:33Z",
"first_roadmap_created_at": "2022-11-01T14:41:11.692054Z",
"address": {
"onboarder_company": 10001,
"address_line_1": "100 Example Street",
"address_line_2": null,
"postal_code": "00000",
"city": "Example City",
"country": "United States",
"state": "Michigan",
"created_at": "2022-11-01T14:38:22Z",
"modified_at": "2024-07-30T17:45:20Z"
},
"has_variables": true,
"has_tasks": true,
"has_project_templates": true,
"has_custom_sending_domain": false,
"has_slack": false,
"payment_subscription_id": "sub_example_id",
"payment_customer_id": "10001",
"trial_end_date": "2022-11-08",
"is_trialing": false,
"terms_acceptance": [
{
"id": 10,
"onboarder_company": {
"id": 10001,
"uuid": "00000000-0000-4000-8000-000000000001",
"company_name": "Example Co",
"slug": "example-co",
"fora_id": "00000000-0000-4000-8000-000000000002",
"is_active": true
},
"accepted_by_user": {
"id": 2002,
"email": "[email protected]"
},
"created_at": "2023-09-22T21:17:45Z",
"modified_at": "2023-09-22T21:17:45Z",
"provider": "openai",
"accepted": true,
"accepted_on": "2023-09-22T21:17:45Z"
}
],
"outboard_settings": {
"domain": null,
"domain_status": "disabled",
"discussion_enabled": true,
"background_color": "#FCFBFF",
"default_project_view": "myTasks"
},
"internal": false,
"chatbot_enabled": false
}- If you see your company payload, your API key and permissions are correct.
- The live response includes your real
default_api_keystring; treat it as secret and avoid logging it in plaintext. - If you receive a 401 or 403 error, double-check your API key and its permissions.
For next steps, try authenticated requests to other endpoints such as /companies/ or explore the full API Reference.
3. Explore endpoint coverage
Open the API Reference for every operation grouped by category, global search (⌘K / Ctrl+K), and interactive request documentation.
How is this guide?