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

# Overview

> Learn about the Taptalent Partner API and its capabilities

The Taptalent Partner API is a RESTful API that provides programmatic access to Taptalent's platform. It allows you to integrate job management, configure webhooks, and build custom recruitment workflows.

## Key Features

### RESTful Architecture

Our API follows REST principles, making it intuitive and easy to use. All endpoints return JSON responses and use standard HTTP methods.

### Authentication

Secure your API calls using API keys. Learn more about [authentication](/authentication/api-keys).

### Webhooks

Configure webhook URLs to receive real-time notifications about important events in your integration. See our [Webhooks documentation](/webhooks/overview) for details.

## Base URL

All API requests should be made to:

**Production:**

```
https://partner-api.taptalent.io/v1/partner
```

**Staging/Sandbox:**

```
https://sandbox.partner-api.taptalent.io/v1/partner
```

## Prerequisites

Before you begin integrating with the TapTalent Partner API, ensure you have:

* **Active TapTalent Workspace**: A valid TapTalent account with an active subscription
* **API Key Access**: Ability to generate API keys (available in Account Settings > Developers)
* **Backend Service**: A backend service capable of making REST API calls
* **Webhook Endpoint** (optional): A publicly accessible HTTPS endpoint for receiving webhook notifications

## Environments

The TapTalent Partner API is available in the following environments:

* **Production**: `https://partner-api.taptalent.io/v1/partner`
  * Use API keys prefixed with `sk_live_`
* **Staging/Sandbox**: `https://sandbox.partner-api.taptalent.io/v1/partner`
  * Use API keys prefixed with `sk_test_`

<Info>
  API keys are prefixed with `sk_live_` for production and `sk_test_` for staging. Make sure to use the appropriate base URL and API key for your environment.
</Info>

## Response Format

All API responses are returned in JSON format. Success responses return the requested data directly, while error responses follow a structured format:

```json theme={null}
{
  "error": {
    "code": "ERROR_CODE",
    "type": "error_type",
    "message": "Human-readable error message",
    "details": {}
  }
}
```

## Next Steps

* Set up [API keys](/authentication/api-keys) for authentication
* Follow our [Quickstart Guide](/getting-started/quickstart) to make your first API call
* Explore the [API Reference](/api-reference/overview) for detailed endpoint documentation
