Quickstart

Before you start

You need to be an admin of a Harlo workspace. The API is included on every Harlo plan. It reads the data of the workspace the key was made in, and nothing else.

Steps

1. Create a key. In Harlo, open Settings, API keys and choose Create API key. Name it after the tool that will use it, pick when it expires, and copy the key. It starts with hk_ and is shown only once.
2. Keep it out of your code.Store it as an environment variable (or in your tool's password field), never in a file you commit:
   ShellCopy

   export HARLO_API_KEY="hk_…"

3. Check it. /meanswers with the key's name and workspace:
   curlJavaScriptPython

   Copy

   curl "https://harlo-api-dev.pages.dev/v1/me" \
     -H "Authorization: Bearer $HARLO_API_KEY"

   200 OKCopy

   {
     "object": "api_key",
     "id": "6dee9b97-7433-4467-82ef-9c7f3b639a0d",
     "name": "Dev HTTP test",
     "prefix": "hk_0f1fd7e",
     "scopes": [
       "read"
     ],
     "workspace": {
       "id": "d4d876ea-b28e-4946-809d-008636e5f3c1",
       "name": "Ridgeline Haulers Test",
       "kind": "carrier"
     },
     "rate_limit_per_minute": 120,
     "created_at": "2026-11-14T13:10:26.273595+00:00",
     "expires_at": null
   }

4. Read some data. The newest five loads, with stops, rate and invoice:
   curlJavaScriptPython

   Copy

   curl "https://harlo-api-dev.pages.dev/v1/loads?limit=5" \
     -H "Authorization: Bearer $HARLO_API_KEY"

What to know

• The base URL is https://harlo-api-dev.pages.dev/v1. Everything is JSON over HTTPS; add format=csv to any list for a spreadsheet.
• Lists come a page at a time, newest first. Pagination and syncing shows how to read everything and then only what changed.
• Each key can make 120 requests a minute. Errors always say what went wrong: Errors and rate limits.
• This version of the API is read-only. It can't change or delete anything in Harlo.