Skip to main content

​
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": "[email protected]",
  ...
}

​
Error Response

{
  "detail": "Error message describing what went wrong"
}

​
HTTP Status Codes

CodeDescription
200Success - Request completed successfully
201Created - Resource created successfully
204No Content - Request succeeded, no content returned
400Bad Request - Invalid request parameters
401Unauthorized - Missing or invalid API key
403Forbidden - Insufficient permissions
404Not Found - Resource not found
429Too Many Requests - Rate limit exceeded
500Internal 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:

​
Endpoints

Person Enrichment

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