Quickstart

One curl, one response. Confirms your token works and the API can see you.

Before you start

You need a Public API token. Log in to Offload as an organization admin, open Settings → API Keys, click Mint new key, and copy the plaintext token from the dialog (it's only shown once). Tokens look like osk_live_8c2c1a7b9d5e.... If the API Keys tab isn't visible, your organization doesn't have the public API enabled yet. Contact your Offload account team (or support@letsoffload.com) to turn it on.

export OFFLOAD_API_TOKEN=osk_live_REPLACE_ME

Who am I?

curl -H "Authorization: Bearer $OFFLOAD_API_TOKEN" \
  https://api.letsoffload.com/api/v1/whoami

A live token returns:

{
  "id": "ak_8c2c1a7b9d5e",
  "object": "whoami",
  "organization": {
    "id": 42,
    "name": "ACME Heavy Haul"
  },
  "key": {
    "prefix": "osk_live_8c2c1a7b",
    "status": "active"
  }
}

A 401 means the token isn't valid (missing, malformed, unknown, or revoked). See Authentication → Errors.

Next

• Authentication: token format, leak handling, rotation.
• API Reference: every endpoint, every field, every error code, plus the integration loop (first push, polling, dry runs, kinds, mappable fields).