Guide
Authentication
The Homerunner API uses HTTP Basic Auth. Every request must include your email address and integration token.
Your credentials
You need two values. Both are available in the Homerunner dashboard under Settings → Integrations.
| Your Homerunner account email — used as the Basic Auth username. | |
| Integration token | Your secret token — used as the Basic Auth password. Treat it like a password. |
Using curl
Pass credentials with the -u flag. curl encodes them automatically:
curl -u you@example.com:integration_token \
https://api2.homerunner.services/v3/shipments
Authorization header
When making requests from code, set the Authorization header directly. The value is Basic followed by base64(email:integration_token):
// Build the header value
const token = btoa('you@example.com:integration_token')
const headers = { Authorization: `Basic ${token}` }
Never commit your integration token to source control. Use environment variables: HOMERUNNER_EMAIL and HOMERUNNER_INTEGRATION_TOKEN.
In the API reference
Every domain page has an Authenticate button in the top nav. Your credentials are saved to localStorage and used automatically in all curl examples and the Try-it runner.
- 1Open any API reference page — for example, Shipments.
- 2Click Authenticate in the top-right of the nav bar.
- 3Enter your Email and Integration token and click Save.
- 4The button turns green. Curl examples and Try-it requests are now pre-filled with your credentials.
Updated 25 July 2026 at 10:50