Getting Started

Steps to get running with the Onboard API quickly.

1. Review base URL and auth

Use your Onboard API base URL and API key (your account team can confirm the host if you are unsure).

Start with a read-only endpoint to validate credentials and permissions.

Continue with the API index at /docs/api-reference.

How is this guide?

Authentication

Authenticate requests to the Onboard REST API using your API key.

Pagination

Fetch large collections safely and efficiently.