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

# Check API Key

> Validate an API key and get its workspace information

Verify an API key is valid and get its associated workspace information.

## Request

```bash theme={null}
curl https://api.series.hr/basic/check-key/YOUR_API_KEY
```

## Parameters

* `apiKey` (path, required): The API key to validate

## Response (Valid Key)

<ResponseField status={200} name="200">
  ```json theme={null}
  {
    "success": true,
    "data": {
      "valid": true,
      "workspaceId": "a7d5339a-5531-4336-99c6-6f3249c9ac20",
      "workspaceName": "My Organization",
      "status": "active",
      "createdAt": "2024-01-01T00:00:00Z",
      "lastUsed": "2024-01-05T11:30:00Z",
      "rateLimitRemaining": 8542,
      "rateLimitReset": "2024-01-05T13:00:00Z"
    }
  }
  ```
</ResponseField>

## Response (Invalid Key)

<ResponseField status={200} name="200">
  ```json theme={null}
  {
    "success": true,
    "data": {
      "valid": false,
      "status": "inactive",
      "message": "API key is inactive or invalid"
    }
  }
  ```
</ResponseField>


## OpenAPI

````yaml GET /basic/check-key/{apiKey}
openapi: 3.0.0
info:
  title: Series API
  version: 1.0.0
  description: >-
    Series API — a free REST API by Sailboat Games, LLC that lets Roblox
    communities programmatically manage workspaces, staff, sessions, time-off
    and activity data.
  contact:
    name: Sailboat Games, LLC.
    email: admin@sailboatgames.com
servers:
  - url: https://api.series.hr
    description: Production API
security:
  - ApiKeyAuth: []
paths:
  /basic/check-key/{apiKey}:
    get:
      tags:
        - Basic
      summary: Check API Key
      description: Verify if an API key is valid
      parameters:
        - name: apiKey
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: API key validation result
      security: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: >-
        Pass your API key in the `apikey` header. Alternatively, the `x-api-key`
        header is also accepted.

````