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

# API Reference

> Complete guide to the Kardow API for job board management, analytics, and programmatic access

## Welcome to the Kardow API

The Kardow API provides comprehensive programmatic access to your job board platform. Whether you're building integrations, automating workflows, or accessing analytics data, our REST API gives you full control over your job board operations.

## API Sections

<CardGroup cols={2}>
  <Card title="Jobs API" icon="briefcase" href="/docs/api-reference/jobs/introduction">
    Create, retrieve, and manage job postings programmatically
  </Card>

  <Card title="Analytics API" icon="chart-line" href="/docs/api-reference/analytics/introduction">
    Access comprehensive analytics data for your job board
  </Card>
</CardGroup>

## Getting Started

### 1. Authentication

All Kardow API endpoints require authentication using API keys. You can generate API keys from your organization settings in the Kardow dashboard.

```bash theme={null}
# Include your API key in the request header
x-api-key: your-api-key-here
```

<Info>
  **API Key Management**: Visit your [Kardow Dashboard](https://app.kardow.com) → Settings → API Keys to generate and manage your API keys.
</Info>

### 2. Base URL

```
https://api.kardow.com
```

### 3. Rate Limits

* **GET requests**: 100 requests per minute
* **POST requests**: 30 requests per minute

<Note>
  Rate limits are applied per API key. Contact support if you need higher limits for bulk operations.
</Note>

## Available Endpoints

### Jobs API

* **GET** `/jobs` - Retrieve job postings with advanced filtering
* **POST** `/jobs` - Create new job postings

### Analytics API

* **GET** `/analytics` - Access site-wide analytics data
* **GET** `/analytics/jobs` - Get visitor analytics for specific jobs

## Response Format

All API responses follow a consistent JSON structure:

```json theme={null}
{
  "data": {
    // Response data
  },
  "meta": {
    // Metadata about the request
  }
}
```

## Error Handling

When API requests fail, you'll receive standardized error responses:

```json theme={null}
{
  "error": {
    "message": "Human-readable error message",
    "code": "machine_readable_error_code",
    "details": "Additional error details",
    "url": "Link to relevant documentation"
  }
}
```

## SDKs & Libraries

While we don't currently offer official SDKs, our REST API is designed to be easy to integrate with any programming language. Here are some popular HTTP client libraries:

<CodeGroup>
  ```javascript JavaScript theme={null}
  // Using fetch (built-in)
  const response = await fetch('https://api.kardow.com/jobs', {
    headers: {
      'x-api-key': 'your-api-key'
    }
  });
  ```

  ```python Python theme={null}
  # Using requests library
  import requests

  response = requests.get('https://api.kardow.com/jobs', headers={
      'x-api-key': 'your-api-key'
  })
  ```

  ```php PHP theme={null}
  // Using cURL
  $ch = curl_init('https://api.kardow.com/jobs');
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'x-api-key: your-api-key'
  ]);
  curl_exec($ch);
  ```
</CodeGroup>

## Support

Need help with the API? Here are your options:

* **Documentation**: Browse our comprehensive API reference
* **Support**: Contact us at [support@kardow.com](mailto:support@kardow.com) for technical assistance

## Changelog

Stay updated with the latest API changes and improvements in our [changelog](/docs/changelog/overview).
