Skip to content
DevelopersGet an API key

The key in use

Which workspace the key belongs to and its limits. A good first call to check a key works.

Retrieve the key

GET/v1/me

curl "https://harlo-api-dev.pages.dev/v1/me" \
  -H "Authorization: Bearer $HARLO_API_KEY"
Example response
{
  "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
}

Fields

FieldTypeWhat it is
objectstringAlways "api_key".
ididUnique id of the key.
namestringWhat you named the key.
prefixstringThe key's first characters, as shown in Settings.
scopesarray of string
workspaceobject
idid
namestring
kindstringcarrier, broker, or both.
rate_limit_per_minuteinteger
created_attimestamp, nullable
expires_attimestamp, nullableNull when it never expires.
NextLoads