SchoolScout API
ContactsContactidEnrich

Enrich contact data

Queue a LinkedIn enrichment job for a contact. Adds profile summary, key facts, photo. Parent district/school must be unlocked, and contact must be unlocked.

POST
/contacts/{contactId}/enrich

Queue a LinkedIn enrichment job for a contact. Adds profile summary, key facts, photo. Parent district/school must be unlocked, and contact must be unlocked.

Authorization

AuthorizationBearer <token>

API key (sk_live_... prefix). Generate keys in the UI under Settings > API Keys, then send it as Authorization: Bearer sk_live_...

In: header

Path Parameters

contactId*string
Formatuuid

Response Body

application/json

application/json

application/json

curl -X POST "https://loading/api/v1/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08/enrich"
{
  "job_id": "string",
  "message": "string"
}
{
  "error": "string",
  "message": "string",
  "statusCode": -9007199254740991
}
{
  "error": "PARENT_ENTITY_LOCKED",
  "message": "string",
  "parent_entity_type": "district",
  "parent_entity_id": "550e8400-e29b-41d4-a716-446655440000",
  "unlock_cost": 0
}

Get generated emails for contact GET

Get previously generated AI outreach emails. Parent district/school must be unlocked, and contact must be unlocked. **Free (0 credits).**

Generate email for contact POST

Generate a personalized outreach email. Parent district/school must be unlocked and contact must be unlocked. **1 credits per generation.**