Fetching data...
Developer API Reference
Build powerful integrations with our platform APIs.
Developer API Reference
Build powerful integrations with our platform APIs.
Connectivity
Dynamic API reference synchronized with our latest backend endpoints.
GET
Verify API connection
/api/v1/meReturns the integration context for the provided API key. Used by Zapier, Make, and other tools to test connectivity.
Example Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/v1/me" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"authenticated": true,
"tenant": {
"id": "string",
"name": "string",
"subdomain": "string"
},
"user": {
"id": "user_123",
"email": "admin@acme.com"
},
"timestamp": "2026-02-25T13:20:00Z"
}GET
Resolve External ID
/api/v1/resolveUtility endpoint to find a PeopleLens AI internal ID using an external system ID (e.g., from Greenhouse or Zapier).
Parameters
typeRequiredstringThe type of entity to resolve
external_idRequiredstringThe ID from the external system
Example Request
bashcurl -X GET "https://your-tenant.peoplelensai.com/api/v1/resolve" \
-H "Authorization: Bearer <YOUR_API_KEY>" \
-H "Content-Type: application/json" Example Response
json{
"found": true,
"id": "string",
"type": "string"
}