API reference · Apollo

apollo/people-match

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APISynchronousOpen model
Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/api/apollo/people-match
Model IDapollo/people-match
01

Input Schema

9 parameters · 0 required · 9 optional

ParameterTypeRequiredDescription
idstringOptionalThe Apollo ID for the person. Each person in the Apollo database is assigned a unique ID. To find IDs, call the People API Search endpoint and identify the values for person_id. Example: 587cf802f65125cad923a266
namestringOptionalThe full name of the person. This will typically be a first name and last name separated by a space. If you use this parameter, you do not need to use the first_name and last_name parameters. Example: tim zheng
emailstringOptionalThe email address of the person. Example: [email protected]
domainstringOptionalThe domain name for the person's employer. This can be the current employer or a previous employer. Do not include www., the @ symbol, or similar. Example: apollo.io or microsoft.com
last_namestringOptionalThe last name of the person. This is typically used in combination with the first_name parameter. Example: zheng
first_namestringOptionalThe first name of the person. This is typically used in combination with the last_name parameter. Example: tim
hashed_emailstringOptionalThe hashed email of the person. The email should adhere to either the MD5 or SHA-256 hash format. Example: 8d935115b9ff4489f2d1f9249503cadf (MD5) or 97817c0c49994eb500ad0a5e7e2d8aed51977b26424d508f66e4e8887746a152 (SHA-256)
linkedin_urlstringOptionalThe URL for the person's LinkedIn profile. Example: http://www.linkedin.com/in/tim-zheng-677ba010
organization_namestringOptionalThe name of the person's employer. This can be the current employer or a previous employer. Example: apollo
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description
03

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/api/apollo/people-match", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({}),
});

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());