> ## 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.

# Open API Capabilities

> What the TapTalent Partner API offers for building integrations: open REST APIs, webhooks, and machine-readable specifications

## Overview

**The TapTalent Partner API is an open, standards-based interface: any external system can
manage jobs, candidates, pipelines, and custom fields programmatically and receive events in
real time.**

No intermediary tooling, manual export/import steps, or proprietary protocols are involved:
integrations are built on authenticated REST/JSON calls and webhook event notifications, both
fully described by the machine-readable OpenAPI 3.1 specification published on this site.

## Capability matrix

| Capability                                             | Supported | Mechanism                                                                                               |
| ------------------------------------------------------ | --------- | ------------------------------------------------------------------------------------------------------- |
| Create, read, update jobs                              | ✅         | REST — `POST/GET/PUT /jobs`                                                                             |
| Create and read candidates                             | ✅         | REST — `POST /candidates`, `GET /candidates/...`                                                        |
| Attach candidates to jobs and move them through stages | ✅         | REST — `/job-candidates/...`                                                                            |
| Pipeline and stage management                          | ✅         | REST — `/pipelines/...`                                                                                 |
| Custom fields (definitions and values)                 | ✅         | REST — `/custom-fields`, `/custom-field-values`                                                         |
| Bulk resume ingestion                                  | ✅         | REST — up to 5,000 resume URLs per batch, asynchronous processing                                       |
| Real-time event notification                           | ✅         | Webhooks — all documented [event types](/webhooks/events) pushed to a partner-configured HTTPS endpoint |
| Sandbox / test environment                             | ✅         | `https://sandbox.partner-api.taptalent.io/v1/partner` with `sk_test_` keys                              |
| Machine-readable API specification                     | ✅         | OpenAPI 3.1.0 (YAML + JSON), downloadable and browsable on this site                                    |
| Postman collection                                     | ✅         | Generated from the specification, with production and sandbox environments                              |
| Interactive API explorer                               | ✅         | API Playground tab on this documentation site                                                           |

## Standards compliance

* **OpenAPI 3.1.0** machine-readable specification (superset of the Swagger specification lineage)
* **REST** architectural style over **HTTPS/TLS**
* **JSON** request and response bodies (`application/json`, UTF-8)
* **HTTP bearer authentication** with company-scoped API keys
* **ISO 8601** timestamps<sup>1</sup>
* Path-based versioning (`/v1`), with breaking changes introduced in new versions with advance
  notice

<sup>1</sup> One documented exception (an epoch timestamp in the jobs list response) is called out
explicitly in the specification.

## Environments and access

| Environment | Base URL                                              | Keys        |
| ----------- | ----------------------------------------------------- | ----------- |
| Production  | `https://partner-api.taptalent.io/v1/partner`         | `sk_live_…` |
| Sandbox     | `https://sandbox.partner-api.taptalent.io/v1/partner` | `sk_test_…` |

API keys are self-service: workspace administrators generate them in the
[TapTalent dashboard](https://client.taptalent.io/dashboard) under **Account Settings →
Developers → API Key Management**. See [Authentication](/authentication/api-keys) for details.

## Integration artifacts

<CardGroup cols={2}>
  <Card title="OpenAPI 3.1 Specification (YAML)" icon="file-code" href="/api-reference/openapi.yaml">
    Canonical machine-readable contract.
  </Card>

  <Card title="OpenAPI 3.1 Specification (JSON)" icon="brackets-curly" href="/api-reference/openapi.json">
    JSON mirror of the specification.
  </Card>

  <Card title="Postman Collection" icon="paper-plane" href="/postman/taptalent-partner-api.postman_collection.json">
    Importable collection covering every endpoint.
  </Card>

  <Card title="Technical Integration Documentation" icon="code" href="/technical-integration/overview">
    Protocols, data structures, communication methods, and how to use these artifacts.
  </Card>
</CardGroup>

## Contact

Questions about integration capabilities, security review, or partnership onboarding:
[support@taptalent.ai](mailto:support@taptalent.ai).