> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tightknit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve the calling API key

> Describes the key the request authenticated with, and the community it reaches.



## OpenAPI

````yaml /openapi-v1.json get /v1/api_key
openapi: 3.1.0
info:
  title: Tightknit Admin API
  version: 1.0.0
  description: Administrative access to a Tightknit community.
servers:
  - url: https://api.tightknit.ai
security:
  - Bearer: []
tags:
  - name: API keys
    description: Inspect the key a request authenticated with.
  - name: Awards
    description: Badges and certificates a community grants its members.
  - name: Events
    description: Read, create, update and delete events on the community calendar.
  - name: Journeys
    description: Read multi-step member programs and their milestones.
  - name: Tags
    description: The labels that classify events and content resources.
  - name: Groups
    description: The segments a community sorts its members into.
  - name: Content
    description: >-
      The collections a community files its content under, and the links and
      events in them.
  - name: Feeds
    description: The Slack channels and site-only spaces a community posts in.
  - name: Files
    description: Images and documents a community has uploaded.
  - name: Messages
    description: What a community has published.
  - name: Members
    description: The people in a community.
  - name: Slack messages
    description: >-
      Messages sent to Slack. Sending is the only operation: they cannot be
      read, edited or deleted here.
  - name: Compositions
    description: >-
      Message Blaster drafts: messages saved in Studio before, and kept after,
      they are sent to Slack channels and members. An API key sees only the
      compositions shared with every Studio user.
  - name: Follows
    description: What a member follows.
  - name: Polls
    description: The questions a community puts to its members in Slack.
  - name: Activity logs
    description: What members did in the community, and when.
  - name: System
    description: Service health.
paths:
  /v1/api_key:
    get:
      tags:
        - API keys
      summary: Retrieve the calling API key
      description: >-
        Describes the key the request authenticated with, and the community it
        reaches.
      operationId: getApiKey
      responses:
        '200':
          description: Success
          headers:
            Request-Id:
              description: Identifier for this request, quote it in support tickets.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKey'
        default:
          description: Error
          headers:
            Request-Id:
              description: Identifier for this request, quote it in support tickets.
              schema:
                type: string
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - Bearer: []
components:
  schemas:
    ApiKey:
      type: object
      properties:
        object:
          type: string
          enum:
            - api_key
          description: Always `api_key`.
        id:
          type: string
          description: Unique identifier for the object.
          example: key_01JQ8ZP9K3XW7B2M4NDYVT6RFC
        name:
          type: string
          description: The name the key was given when created.
          example: Production integration
        obfuscated_value:
          type: string
          description: The key with all but its last characters masked, to tell keys apart.
          example: sk_live_**********4f2a
        permissions:
          type: array
          items:
            type: string
          description: >-
            The permission slugs the key holds, which decide what it may read
            and write.
          example:
            - api:admin:messages
        created_at:
          type: string
          format: date-time
          description: When the object was created.
        community_name:
          type: string
          description: The name of the community the key reaches.
          example: Acme Corporation
      required:
        - object
        - id
        - name
        - obfuscated_value
        - permissions
        - created_at
        - community_name
    Problem:
      type: object
      properties:
        type:
          type: string
          description: A URI naming the problem type. Always `about:blank`.
          example: about:blank
        title:
          type: string
          description: A short summary of the HTTP status.
          example: Not found
        status:
          type: integer
          description: The HTTP status code.
          example: 404
        detail:
          type: string
          description: What went wrong with this request, when there is more to say.
        code:
          type: string
          description: >-
            A stable, machine-readable error code to branch on, unlike `title`
            and `detail`.
          example: not_found
        param:
          type: string
          description: The request field or parameter the error is about, when one is.
        request_id:
          type: string
          description: >-
            The id of the request, also sent as the `Request-Id` header. Quote
            it in support tickets.
          example: req_9f2b8c1d4e5a6b7c8d9e0f1a2b3c4d5e
      required:
        - type
        - title
        - status
        - code
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: Tightknit API key
      description: 'A Tightknit admin API key, sent as `Authorization: Bearer <key>`.'

````

## Related topics

- [API Keys](https://docs.tightknit.ai/integrations/api-keys.md)
- [Retrieve a composition](https://docs.tightknit.ai/v1/api-reference/compositions/retrieve-a-composition.md)
- [Retrieve a message attachment](https://docs.tightknit.ai/v1/api-reference/messages/retrieve-a-message-attachment.md)
- [Retrieve a poll](https://docs.tightknit.ai/v1/api-reference/polls/retrieve-a-poll.md)
- [Retrieve a composition delivery](https://docs.tightknit.ai/v1/api-reference/compositions/retrieve-a-composition-delivery.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.