Enrich contacts
Interactive reference and playground for POST /v1/enrich/email and POST /v1/enrich/phone.
Authorization
apiKey API key issued from the JobsPipe dashboard, prefixed jp_live_, sent as a bearer token in the Authorization header. Keys are read-only and scoped: jobs:read grants POST /v1/jobs/search, stack:read grants POST /v1/stack/scan. No scope grants write access to JobsPipe data.
In: header
Header Parameters
Optional client-generated key (e.g. a UUID) that makes this POST safe to retry. A repeat with the same key returns the original response plus an Idempotent-Replayed: true header. Keys are retained for 24 hours.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/enrich/email" \ -H "Content-Type: application/json" \ -d '{ "items": [ { "linkedin_url": "https://www.linkedin.com/in/jane-doe" }, { "full_name": "Sam Lee", "domain": "acme.com" } ] }'{ "results": [ { "index": 0, "status": "enriched", "type": "work", "value": "jane.doe@northwind.com", "credits": 15 }, { "index": 1, "status": "not_found", "type": "work", "value": null, "credits": 0 } ], "found": 1, "credits_charged": 15}{ "error": "string", "message": "string"}{ "error": "string", "message": "string"}{ "error": "string", "message": "string"}{ "error": "string", "message": "string"}{ "error": "string"}Authorization
apiKey API key issued from the JobsPipe dashboard, prefixed jp_live_, sent as a bearer token in the Authorization header. Keys are read-only and scoped: jobs:read grants POST /v1/jobs/search, stack:read grants POST /v1/stack/scan. No scope grants write access to JobsPipe data.
In: header
Header Parameters
Optional client-generated key (e.g. a UUID) that makes this POST safe to retry. A repeat with the same key returns the original response plus an Idempotent-Replayed: true header. Keys are retained for 24 hours.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/enrich/phone" \ -H "Content-Type: application/json" \ -d '{ "items": [ { "linkedin_url": "https://www.linkedin.com/in/jane-doe" } ] }'{ "results": [ { "index": 0, "status": "cached", "type": "phone", "value": "+1 415 555 0142", "credits": 0 } ], "found": 1, "credits_charged": 0}{ "error": "string", "message": "string"}{ "error": "string", "message": "string"}{ "error": "string", "message": "string"}{ "error": "string", "message": "string"}{ "error": "string"}