Verify your key

GET /me is the cheapest, side-effect-free endpoint for checking authentication. A 200 means the key is valid, active, and points at the expected org.

curl https://api.awardee.com/v1/me \
  -H "Authorization: Bearer aw_live_4f8a3c7e2d1b9a5c6f8e3d2c1b4a9f7e"

const res = await fetch("https://api.awardee.com/v1/me", {
  headers: {
    Authorization: "Bearer aw_live_4f8a3c7e2d1b9a5c6f8e3d2c1b4a9f7e",
  },
})
console.log(res.status, await res.json())

import requests

res = requests.get(
    "https://api.awardee.com/v1/me",
    headers={
        "Authorization": "Bearer aw_live_4f8a3c7e2d1b9a5c6f8e3d2c1b4a9f7e"
    },
)
print(res.status_code, res.json())

Successful response (personal API key):

{
  "object": "me",
  "connection_label": "Acme Inc",
  "org_name": "Acme Inc",
  "auth": { "type": "api_key" },
  "org": {
    "id": "8f3a9d2e-1b4c-4f5d-9e8a-7c3b2a1d0f9e",
    "name": "Acme Inc",
    "slug": "acme-inc"
  },
  "api_key": {
    "id": "2c1b4a9f-7e8d-4a3c-9b1f-6e5d4c3b2a1f",
    "name": "crm-sync-prod"
  }
}

When called with an OAuth access token (awo_live_…), auth.type is "oauth_token" and the response instead carries the granting client, the authorized scopes, and the acting user:

{
  "object": "me",
  "connection_label": "Acme Inc",
  "org_name": "Acme Inc",
  "auth": {
    "type": "oauth_token",
    "client": {
      "client_id": "awc_3d2c1b4a9f7e",
      "name": "Zapier",
      "logo_url": null
    },
    "scopes": ["qr.view", "objects.manage"]
  },
  "org": {
    "id": "8f3a9d2e-1b4c-4f5d-9e8a-7c3b2a1d0f9e",
    "name": "Acme Inc",
    "slug": "acme-inc"
  },
  "user": {
    "id": "6e5d4c3b-2a1f-4e8d-9b1f-7e8d4a3c9b1f",
    "first_name": "Dana",
    "last_name": "Lee"
  }
}

A 401 with missing_api_key means the Bearer prefix is missing. A 401 with invalid_api_key means the value isn’t recognized. See Authentication for the full list of auth errors.

Get started

Identity

Concepts

Webhooks

Chatbots

Customers

Articles

Article Categories

Article Tags

Knowledge Bases

Conversations

Conversation Tags

Submissions

Pages

QR Codes

QR Groups

Products

Objects

Custom Domains

Custom Domain Routes

Team