Skip to main content
Retrieve the calling API key

Authorizations

Authorization
string
header
required

A Tightknit admin API key, sent as Authorization: Bearer <key>.

Response

Success

object
enum<string>
required

Always api_key.

Available options:
api_key
id
string
required

Unique identifier for the object.

Example:

"key_01JQ8ZP9K3XW7B2M4NDYVT6RFC"

name
string
required

The name the key was given when created.

Example:

"Production integration"

obfuscated_value
string
required

The key with all but its last characters masked, to tell keys apart.

Example:

"sk_live_**********4f2a"

permissions
string[]
required

The permission slugs the key holds, which decide what it may read and write.

Example:
created_at
string<date-time>
required

When the object was created.

community_name
string
required

The name of the community the key reaches.

Example:

"Acme Corporation"