Account

Get the current key

get/me

Returns the key, its workspace, and the current monthly allowance. Any valid key can call this, so it is a good first request.

Works with any valid key.

Example request

curl "https://www.inkly.so/api/v1/me" \
  -H "Authorization: Bearer $INKLY_API_KEY"

Example response, 200

{
  "key": {
    "name": "CRM integration",
    "last_four": "x7Qa",
    "scopes": [
      "templates:read",
      "documents:read",
      "documents:send"
    ]
  },
  "workspace": {
    "id": "6c0e2b91-5d47-4a83-b2f6-7e9a1c3d8f50",
    "name": "Northwind Studio",
    "plan": "pro"
  },
  "allowance": {
    "limit": 250,
    "used": 12,
    "remaining": 238,
    "resets_at": "2026-12-01T00:00:00.000Z"
  }
}

Response fields

keyobjectRequired
3 child fields
- namestringRequired
- last_fourstringRequired
- scopesarray of stringsRequired
  Each one of templates:read, documents:read, documents:send
workspaceobjectRequired
3 child fields
- idUUIDRequired
- namestringRequired
- planstringRequired
  One of pro, teams
allowanceobjectRequired
4 child fields
- limitnumberRequired
  API documents this workspace can create each month, which depends on its plan.
- usednumberRequired
- remainingnumberRequired
- resets_attimestampRequired
  The first of next month, UTC.