Account

Get the current API key's workspace and scopes

Returns the workspace the API key belongs to, the key's id and scopes, and the source value that events caused by this key carry. Use it to test that a key works. Requires the read scope.

get/me

Request

Base URL: https://app.huddlekit.com/api/v1
URL: https://app.huddlekit.com/api/v1/me
Auth: HTTP bearer

Response

The key's workspace and scopes.

workspace_idstring uuid required

Id of the workspace the key belongs to.

workspace_namestring nullable required

Name of the workspace, or null if it could not be read.

key_idstring uuid required

Id of this API key (not the secret key itself).

scopesstring[] required

Scopes granted to this key. read allows GET calls; write allows POST, PATCH and DELETE calls.

sourcestring required

The source value that events caused by this key carry, connector:<key_id>. A consumer that both reads and writes comments should ignore events whose source equals this value, to avoid loops.

Example response

{
  "workspace_id": "9a4e2b7c-1d5f-4a8e-b3c6-7e0f2d9a1b58",
  "workspace_name": "Acme Studio",
  "key_id": "c2a8e4f1-7b3d-4e9a-b6c5-1f0d8e2a7b93",
  "scopes": [
    "read",
    "write"
  ],
  "source": "connector:c2a8e4f1-7b3d-4e9a-b6c5-1f0d8e2a7b93"
}

Changes

No recorded changes to this operation across all 1 revision of this API.