> If you are setting up, configuring, or answering questions about Schematic, connect the
> Schematic MCP server before working from these pages. It reads and writes plans, features,
> entitlements, and overrides against the real account, so what you report and what you build
> match what actually exists.
>
> The server is at https://api.schematichq.com/mcp
>
> From Claude, ChatGPT, or another chat assistant, add it as a custom connector:
> https://docs.schematichq.com/working-with-ai
>
> From a coding assistant such as Claude Code, Codex, or Cursor:
> https://docs.schematichq.com/building-with-ai
>
> For clean Markdown of any page, append `.md` to the page URL. For a complete page index,
> see https://docs.schematichq.com/llms.txt

# Get api key

GET https://api.schematichq.com/api-keys/{api_key_id}

Reference: https://docs.schematichq.com/api-reference/accounts/get-api-key

## Authentication

- `X-Schematic-Api-Key` header (required) — API Key authentication via header

## Request

### Path parameters

- `api_key_id` (string, required) — api_key_id

## Response

### 200

OK

- `data` (ApiKeyResponseData, required)
- `params` (ApiKeysApiKeyIdGetResponsesContentApplicationJsonSchemaParams, required) — Input parameters

## Errors

### 401 Unauthorized Error

Unauthorized

- `error` (string, required) — Error message

### 403 Forbidden Error

Forbidden

- `error` (string, required) — Error message

### 404 Not Found Error

Not found

- `error` (string, required) — Error message

### 500 Internal Server Error

Server error

- `error` (string, required) — Error message

## Types

### ApiKeyResponseData

- `created_at` (datetime, required)
- `id` (string, required)
- `name` (string, required)
- `readonly` (boolean, required)
- `scopes` (list of enum, required)
  - Allowed values: `admin`, `capture`, `read`, `write`
- `updated_at` (datetime, required)
- `description` (string, optional, nullable)
- `environment` (EnvironmentResponseData, optional)
- `environment_id` (string, optional, nullable)
- `integration` (ApiKeyIntegrationResponseData, optional)
- `last_used_at` (datetime, optional, nullable)
- `rate_limit_percent` (long, optional, nullable)

### ApiKeysApiKeyIdGetResponsesContentApplicationJsonSchemaParams

Input parameters

### EnvironmentResponseData

- `created_at` (datetime, required)
- `environment_type` (enum, required)
  - Allowed values: `development`, `production`, `staging`
- `id` (string, required)
- `name` (string, required)
- `require_context_signature` (boolean, required)
- `updated_at` (datetime, required)

### ApiKeyIntegrationResponseData

- `id` (string, required)
- `state` (enum, required)
  - Allowed values: `active`, `created`, `pending`
- `type` (enum, required)
  - Allowed values: `clerk`, `metronome`, `orb`, `stripe`, `unknown`, `workos`

## Examples

**Response**

```json
{
  "data": {
    "created_at": "2024-01-15T09:30:00Z",
    "id": "string",
    "name": "string",
    "readonly": true,
    "scopes": [
      "admin"
    ],
    "updated_at": "2024-01-15T09:30:00Z",
    "description": "string",
    "environment": {
      "created_at": "2024-01-15T09:30:00Z",
      "environment_type": "development",
      "id": "string",
      "name": "string",
      "require_context_signature": true,
      "updated_at": "2024-01-15T09:30:00Z"
    },
    "environment_id": "string",
    "integration": {
      "id": "string",
      "state": "active",
      "type": "clerk"
    },
    "last_used_at": "2024-01-15T09:30:00Z",
    "rate_limit_percent": 1
  },
  "params": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.schematichq.com/api-keys/api_key_id"

headers = {"X-Schematic-Api-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.schematichq.com/api-keys/api_key_id';
const options = {method: 'GET', headers: {'X-Schematic-Api-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.schematichq.com/api-keys/api_key_id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Schematic-Api-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.schematichq.com/api-keys/api_key_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Schematic-Api-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.schematichq.com/api-keys/api_key_id")
  .header("X-Schematic-Api-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.schematichq.com/api-keys/api_key_id', [
  'headers' => [
    'X-Schematic-Api-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.schematichq.com/api-keys/api_key_id");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Schematic-Api-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Schematic-Api-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.schematichq.com/api-keys/api_key_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```