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

# API Reference

> Complete reference for the People Context API

## Base URL

All API requests should be made to:

```
https://api.peoplecontext.com
```

## Authentication

All requests require an API key passed in the `Authorization` header:

```bash theme={null}
Authorization: Bearer your_api_key_here
```

See [Authentication](/guides/authentication) for detailed information.

## Response Format

All responses are returned as JSON with appropriate HTTP status codes.

### Success Response

```json theme={null}
{
  "id": 1,
  "full_name": "John Doe",
  "email": "john@example.com",
  ...
}
```

### Error Response

```json theme={null}
{
  "detail": "Error message describing what went wrong"
}
```

## HTTP Status Codes

| Code | Description                                         |
| ---- | --------------------------------------------------- |
| 200  | Success - Request completed successfully            |
| 201  | Created - Resource created successfully             |
| 204  | No Content - Request succeeded, no content returned |
| 400  | Bad Request - Invalid request parameters            |
| 401  | Unauthorized - Missing or invalid API key           |
| 403  | Forbidden - Insufficient permissions                |
| 404  | Not Found - Resource not found                      |
| 429  | Too Many Requests - Rate limit exceeded             |
| 500  | Internal Server Error - Server error                |

## Rate Limiting

API rate limits are enforced per API key. Response headers include:

```
X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1635724800
```

See [Authentication](/guides/authentication) for rate limit details by plan.

## Websets

Use the `websets` parameter to specify which data sources to include:

```json theme={null}
POST /v1/person/enrich
{
  "github": "username",
  "websets": ["github"]
}
```

Currently supported websets:

* `github` - GitHub profile data, repositories, commits, and activity

## Versioning

The API version is included in the URL path:

```
/v1/...
```

We maintain backward compatibility within major versions. Breaking changes will result in a new major version.

## OpenAPI Specification

Download the OpenAPI specification:

```bash theme={null}
curl https://api.peoplecontext.com/v1/openapi.json
```

Or view the interactive documentation at:

```
https://api.peoplecontext.com/docs
```

## Support

Need help? Contact us:

* **Email**: [justin@peoplecontext.com](mailto:justin@peoplecontext.com)
* **Documentation**: [docs.peoplecontext.com](https://docs.peoplecontext.com)

## Endpoints

<CardGroup cols={1}>
  <Card title="Person Enrichment" icon="user" href="/api-reference/person/enrich">
    Enrich person profiles using GitHub username or email address. Get comprehensive GitHub profile data including repositories, commits, activity, and more.
  </Card>
</CardGroup>