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

# Introduction

> The Outhire API lets you programmatically manage jobs and candidates.

The Outhire public API provides RESTful endpoints for integrating your recruiting workflows with external systems.

## Base URL

```
https://app.outhire.ai/api/v1
```

## Authentication

All endpoints require a Bearer token in the `Authorization` header. See [Authentication](/api-reference/authentication) for details on creating and managing API keys.

```bash theme={null}
curl https://app.outhire.ai/api/v1/jobs \
  -H "Authorization: Bearer outh_your_api_key_here"
```

## Available endpoints

### Jobs

| Method | Endpoint           | Description        |
| ------ | ------------------ | ------------------ |
| `GET`  | `/api/v1/jobs`     | List all jobs      |
| `GET`  | `/api/v1/jobs/:id` | Get a specific job |

### Candidates

| Method  | Endpoint                       | Description                                        |
| ------- | ------------------------------ | -------------------------------------------------- |
| `GET`   | `/api/v1/candidates`           | List candidates                                    |
| `POST`  | `/api/v1/candidates`           | Create a candidate (JSON or multipart with resume) |
| `GET`   | `/api/v1/candidates/:id`       | Get a specific candidate                           |
| `PATCH` | `/api/v1/candidates/:id`       | Update a candidate                                 |
| `GET`   | `/api/v1/candidates/:id/notes` | List candidate notes                               |
| `POST`  | `/api/v1/candidates/:id/notes` | Add a note to a candidate                          |

## Response format

All responses return JSON. Errors use a consistent envelope:

```json theme={null}
{
  "error": {
    "code": "not_found",
    "message": "Resource not found."
  }
}
```

See [Authentication](/api-reference/authentication#api-error-format) for the full list of error codes.