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

# Cutshort REST API: Candidates, Jobs, and Sourcing Endpoints

> Complete reference for the Cutshort REST API. Authenticate with an API key and access endpoints for candidates, jobs, sourcing, and webhooks.

The Cutshort REST API gives you programmatic access to India's largest premium tech talent pool. Use it to search candidates, manage job postings, trigger AI-powered shortlisting, and configure webhooks — all with standard HTTP requests and JSON responses.

## Base URL

```
https://api.cutshort.io/v1
```

<Note>
  All endpoints use HTTPS. HTTP requests are automatically redirected.
</Note>

## Authentication

Include the following headers on every request:

```http theme={null}
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
```

See the [Authentication](/authentication) page for details on generating and managing your API key.

## Request Format

* All requests and responses use JSON.
* Set `Content-Type: application/json` on all POST and PATCH requests.
* Query parameters are used for GET filters.

## Response Format

A standard success response looks like this:

```json theme={null}
{
  "data": { ... },
  "meta": {
    "total": 412,
    "page": 1,
    "per_page": 20
  }
}
```

A standard error response looks like this:

```json theme={null}
{
  "error": {
    "code": "validation_error",
    "message": "skills parameter is required",
    "details": [
      { "field": "skills", "issue": "missing required parameter" }
    ]
  }
}
```

## Endpoints Summary

| Method  | Endpoint                   | Description                    |
| ------- | -------------------------- | ------------------------------ |
| `GET`   | `/candidates/search`       | Search candidates by filters   |
| `GET`   | `/candidates/{id}`         | Get a candidate by ID          |
| `GET`   | `/candidates/{id}/profile` | Get full candidate profile     |
| `GET`   | `/jobs`                    | List your organization's jobs  |
| `POST`  | `/jobs`                    | Create a new job               |
| `PATCH` | `/jobs/{id}`               | Update a job                   |
| `POST`  | `/sourcing/shortlist`      | Generate a candidate shortlist |
| `POST`  | `/sourcing/invite`         | Send invites to candidates     |
| `GET`   | `/webhooks`                | List webhook endpoints         |
| `POST`  | `/webhooks`                | Register a webhook             |

## Versioning

<Note>
  The current API version is `v1`. Breaking changes will be announced with a new version prefix. The v1 endpoints will remain available for at least 12 months after any v2 launch.
</Note>
