API Reference

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:

Authorization: Bearer your_api_key_here

See Authentication for detailed information.

Response Format

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

Success Response

{
  "id": 1,
  "full_name": "John Doe",
  "email": "john@example.com",
  ...
}

Error Response

{
  "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 for rate limit details by plan.

Websets

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

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:

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
Documentation: docs.peoplecontext.com

Endpoints

Person Enrichment

Enrich person profiles using GitHub username or email address. Get comprehensive GitHub profile data including repositories, commits, activity, and more.

API Documentation

Person Endpoints

Company Endpoints

Base URL

Authentication

Response Format

Success Response

Error Response

HTTP Status Codes

Rate Limiting

Websets

Versioning

OpenAPI Specification

Support

Endpoints

Person Enrichment

​Base URL

​Authentication

​Response Format

​Success Response

​Error Response

​HTTP Status Codes

​Rate Limiting

​Websets

​Versioning

​OpenAPI Specification

​Support

​Endpoints

Person Enrichment

Base URL

Authentication

Response Format

Success Response

Error Response

HTTP Status Codes

Rate Limiting

Websets

Versioning

OpenAPI Specification

Support

Endpoints