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

# Check your API key

> Returns the workspace and key a request is authenticated as, plus a count of documents by status. Call this first to confirm a new key works.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/me
openapi: 3.1.0
info:
  title: Suresign API
  version: 1.0.0
  description: >-
    Read the documents in your Suresign workspace and download their PDFs.
    Available on the Pro and Business plans.
servers:
  - url: https://suresign.si
    description: Suresign
security:
  - bearerAuth: []
tags:
  - name: Workspace
    description: Check which workspace a key opens.
  - name: Documents
    description: List, read and download documents.
paths:
  /api/v1/me:
    get:
      tags:
        - Workspace
      summary: Check your API key
      description: >-
        Returns the workspace and key a request is authenticated as, plus a
        count of documents by status. Call this first to confirm a new key
        works.
      operationId: getMe
      responses:
        '200':
          description: The workspace this key opens.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      workspace:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                      key:
                        type: object
                        properties:
                          id:
                            type: string
                          name:
                            type: string
                      documents:
                        type: object
                        description: >-
                          Document counts keyed by lowercase status, for example
                          `completed`. Statuses with no documents are left out.
                        additionalProperties:
                          type: integer
              example:
                data:
                  workspace:
                    id: ws_123
                    name: Northwind Studio
                  key:
                    id: key_123
                    name: crm-sync
                  documents:
                    draft: 2
                    sent: 3
                    completed: 14
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PlanRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  responses:
    Unauthorized:
      description: The key is missing, malformed, revoked or unknown.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: That key is not valid.
    PlanRequired:
      description: >-
        The key is valid, but the workspace's plan does not include the API. The
        key is kept and works again once the workspace is on Pro or Business.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              details:
                type: object
                properties:
                  code:
                    type: string
                    example: plan_limit
                  upgrade:
                    type:
                      - string
                      - 'null'
                    example: pro
                  href:
                    type: string
                    description: Where to upgrade.
    Forbidden:
      description: The workspace is suspended, so its API keys are refused.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: This workspace is suspended, so its API keys are refused.
    RateLimited:
      description: More than 300 requests in a minute with this key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Rate limit exceeded. Try again in 12 seconds.
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: A plain-language explanation of what went wrong.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your workspace API key, which starts with `dtd_`. Send it as
        `Authorization: Bearer dtd_...`.

````

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