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

# Introduction

> Overview of the TapTalent Partner API and how to integrate with it

Welcome to the **TapTalent Partner API** documentation.

This documentation is designed to help engineering teams integrate with the TapTalent platform in a secure, scalable, and production-ready manner. The Partner API provides programmatic access to core hiring entities and workflows, enabling you to build custom integrations, synchronize systems, and automate recruitment processes across your technology stack.

***

## What the Partner API Enables

The TapTalent Partner API exposes a set of RESTful endpoints and event-driven mechanisms that allow external systems to interact directly with the TapTalent hiring platform.

Using the API, you can:

* Programmatically create, update, and retrieve **candidates**
* Sync **jobs** and manage role-level hiring data
* Track **submissions** and candidate status changes
* Subscribe to **webhooks** for real-time event notifications
* Build automated or hybrid workflows that combine system-driven logic with human decision-making

The API is designed to support **enterprise-scale integrations**, including high-volume data ingestion, bi-directional synchronization, and distributed system architectures.

***

## Who This Documentation Is For

This documentation is intended for:

* Backend and platform engineers
* Integration and solutions architects
* Technical product owners
* Teams building ATS, CRM, HRIS, or recruitment automation tools

A working knowledge of REST APIs, JSON, and HTTP authentication is assumed.

***

## How the Platform Fits Into Your Architecture

TapTalent can act as:

* A source of candidate and hiring workflow data
* A downstream system receiving candidates, jobs, or updates
* An event publisher notifying your systems of hiring activity
* A coordination layer for AI-driven and human-led recruitment processes

The Partner API is flexible by design, allowing you to adopt one-way, bi-directional, or event-driven integration patterns depending on your operational needs.

***

## How This Documentation Is Structured

This documentation is organized to help you move from **first request** to **production integration**:

* **Getting Started** – Understand the integration flow and make your first API call
* **Authentication** – Learn how to securely authenticate requests using API keys
* **API Reference** – Explore endpoints for candidates, jobs, and submissions
* **Webhooks** – Receive real-time updates for important platform events
* **Integration Notes** – Review best practices, scaling considerations, and common pitfalls

***

## Getting Started

If you are integrating for the first time, begin with the\
👉 **[Quick Start Guide](/getting-started/quickstart)**\
to generate an API key and make your first successful request.

***

## Need Guidance or Best Practices?

For architectural guidance, real-world integration patterns, and operational considerations, refer to\
👉 **[Integration Notes](/integration-notes/overview)**.

These notes are especially useful for teams building enterprise-grade or high-volume integrations.

***

This introduction sets the foundation for the sections that follow and is the recommended starting point for all Partner API integrations.