Reference

Me

Check an API key and read the workspace it belongs to.

Call this first with a new key: it proves the key works and tells you which workspace and scopes it carries.

Get the current key

GET/api/v1/meScope workspace:read

Returns the key (id, name, prefix and scopes) and its workspace. Never returns the secret.

Example request

curl -s "https://app.graphkit.com/api/v1/me" \
  -H "Authorization: Bearer $GRAPHKIT_API_KEY"

Response 200

FieldTypeDescription
apiKeyobject
apiKey.idstring (uuid)UUID.
apiKey.namestring
apiKey.prefixstring
apiKey.scopesarray of stringValues: workspace:read, senders:read, leads:read, leads:write, campaigns:read, campaigns:write, inbox:read, inbox:write, webhooks:manage, kit:read, kit:write, mcp:read, mcp:write, mcp:accounts:read, mcp:accounts:write, mcp:leads:read, mcp:leads:write, mcp:campaigns:read, mcp:campaigns:write, mcp:inbox:read, mcp:inbox:write, mcp:analytics:read, mcp:analytics:write, mcp:integrations:read, mcp:integrations:write, mcp:workspace:read, mcp:workspace:write, mcp:billing:read, mcp:billing:write, mcp:autopilot:read, mcp:autopilot:write, mcp:infrastructure:read, mcp:infrastructure:write.
workspaceobject
workspace.idstring (uuid)UUID.
workspace.namestring
workspace.organizationIdstring (uuid)
{
  "apiKey": {
    "id": "0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99",
    "name": "Q1 founders, UK",
    "prefix": "gk_live_3fA9",
    "scopes": [
      "workspace:read",
      "senders:read"
    ]
  },
  "workspace": {
    "id": "0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99",
    "name": "Q1 founders, UK",
    "organizationId": "0193a5b2-7c1e-7a10-9f2a-2b3c4d5e6f99"
  }
}

Errors

StatusCode and meaning
401invalid_api_key: the key is missing, unknown or revoked.
403insufficient_scope: the key lacks the scope this endpoint needs.
429rate_limited: more than 300 requests in a minute; wait for Retry-After.

On this page