# Kini API Docs

## Guides

- [Welcome to Kini API](https://docs.getkini.com/home.md): No description found
- [Getting Started](https://docs.getkini.com/guides/getting-started.md): Welcome to the Kini API! This guide will help you integrate quickly and start leveraging our features for managing jobs, candidates, and applications.
- [Authentication](https://docs.getkini.com/guides/authentication.md): The Kini API uses Bearer API Key authentication to ensure secure and simplified access to all API resources.
- [Pagination](https://docs.getkini.com/guides/pagination.md): Efficient handling of large datasets is essential for scalable API integrations. The Kini API supports a pagination system to manage large volumes of data efficiently across multiple endpoints.
- [Filtering](https://docs.getkini.com/guides/filtering.md): Efficient data retrieval often requires filtering the dataset to match specific criteria. The Kini API supports filtering across multiple endpoints.
- [Error Handling](https://docs.getkini.com/guides/error-handling.md): The Kini API is designed to provide clear and actionable error messages to help you diagnose and resolve issues quickly.
- [Rate Limits](https://docs.getkini.com/guides/rate-limits.md): Learn about rate limits for the Kini API.
- [Overview ATS Supported Fields](https://docs.getkini.com/guides/overview-ats-supported-fields.md): Below you see 2 tables: supported fields for Job Sync and the supported fields for Candidate Sync for all the different supported ATS's.

## Integrations

- [QuickApply Integrations](https://docs.getkini.com/integrations/quickapply/index.md): Overview of QuickApply API integrations with job boards
- [Indeed](https://docs.getkini.com/integrations/quickapply/indeed.md): Instructions for integrating QuickApply with Indeed
- [Meta Lead Forms](https://docs.getkini.com/integrations/quickapply/meta-lead-forms.md): Forward Meta (Facebook) Lead Ads submissions to your ATS via the Kini QuickApply webhook URL.
- [Perspective Funnels](https://docs.getkini.com/integrations/quickapply/perspective.md): Instructions for configuring Perspective so that candidate applications are successfully sent to Kini and then forwarded to your Applicant Tracking System (ATS) in real time.

## Webhooks

- [Webhooks Overview](https://docs.getkini.com/webhooks/overview.md): Overview of the webhooks Kini offers for real-time updates on application and job events.
- [Application Sync Status Update](https://docs.getkini.com/webhooks/application-sync-status-update.md): The Status Webhook allows you to receive real-time updates on application statuses. Whenever an application's status changes, a Webhook Payload will be sent to a URL you define.
- [Job Update Webhook](https://docs.getkini.com/webhooks/job-update.md): Payload schema and behavior for the Job Update webhook, fired on job create, update, and archive events.
- [Job Booking Status Update](https://docs.getkini.com/webhooks/job-booking-status-update.md): The Status Webhook allows you to receive real-time updates on job booking statuses. Whenever a job booking is booked or published, a Webhook Payload will be sent to a URL you define.

## API Reference

- [Applications](https://docs.getkini.com/api/applications/index.md): Submit, list, and retrieve job applications received through the Kini API.
- [List Applications](https://docs.getkini.com/api/get-applications.md): Read several Application details identified by their unique Company ID.
- [Create Application](https://docs.getkini.com/api/post-applications.md): Create a Job Application to a Company using the Company's ID.
- [Get Application](https://docs.getkini.com/api/get-applications-id.md): Read a specific Application detail identified by its unique ID.
- [Jobs](https://docs.getkini.com/api/jobs/index.md): List, create, retrieve, and update job postings managed through the Kini API.
- [List Jobs](https://docs.getkini.com/api/get-jobs.md): Read several Job details identified by their unique Company ID.
- [Create Job](https://docs.getkini.com/api/post-jobs.md): Create a Job posting at a Company using the Company's ID.
- [Get Job](https://docs.getkini.com/api/get-jobs-id.md): Read a specific Job detail identified by its unique ID.
- [Update Job](https://docs.getkini.com/api/patch-jobs-id.md): Update a specific Job partially by its unique ID.
- [Companies](https://docs.getkini.com/api/companies/index.md): Look up, manage, and synchronize the companies accessible with your API credentials.
- [List Companies](https://docs.getkini.com/api/get-companies.md): List companies that the authenticated user has access to through agencies or partners.
- [Create Company](https://docs.getkini.com/api/post-companies.md): Create a new Company under a partner and an ATS integration. The authenticated partner becomes the owning partner of the resulting record.
- [Get Single Company](https://docs.getkini.com/api/get-companies-id.md): Retrieve a specific Company identified by its unique ID.
- [Update Company](https://docs.getkini.com/api/patch-companies-id.md): Update a specific Company partially by its unique ID. Only the fields included in the request body are modified.
- [Create Magic Link](https://docs.getkini.com/api/post-companies-id-magic.md): Create or retrieve an active magic link for the Company. If an active link already exists, its URL is returned with status `200`. Otherwise a new link is created and returned with status `201`.
- [Trigger Job Sync](https://docs.getkini.com/api/post-companies-id-sync-jobs.md): Trigger a manual job synchronization from the ATS for the given Company. Throttled to one request per minute per company.
- [Deactivate Company](https://docs.getkini.com/api/patch-companies-id-deactivate.md): Mark the Company as deactivated and notify internal channels. The record is retained but excluded from active listings.
- [Shop](https://docs.getkini.com/api/shop/index.md): Generate clickout links that route users from channel campaigns to a customer's shop.
- [Create a clickout link to access the shop](https://docs.getkini.com/api/post-clickout.md): Creates a new clickout link to access the shop