Skip to content
/Contacts

Revealed Employee Finder API (1.0.0)

API for finding employee contact information from companies using various criteria.

Download OpenAPI description
index.json
index.yaml
Overview
API Support
api-support@revealead.com
License
Proprietary
Languages
Servers
Mock server
https://docs.revealead.com/_mock/apis
Production Server
https://api.revealead.app/employeefinder

Companies

Operations

Contacts

Operations

Get Contacts by Company

Request

Retrieve contacts for a specific company using its ID or Registration Number.

Security
ApiKeyHeader or ApiKeyQuery
Path
company_idstringrequired

The internal Company ID OR the official Registration Number (e.g., GB06441592).

Query
show_all_anonymizedboolean

If true, returns anonymized preview data (free of charge).

Default false
withemailboolean

Filter Include only contacts with email addresses.

withlinkedinboolean

Filter Include only contacts with LinkedIn URLs.

withlegalboolean

Filter Include only legal representatives.

email_test_statusstring

Filter by email verification status.

Default "all"
Enum"all""safe""notsafe"
contact_maxinteger<= 100

Maximum number of contacts to return.

Default 50
contact_idsArray of strings

List of specific Contact IDs to retrieve (overrides filters).

curl -i -X GET \
  'https://docs.revealead.com/_mock/apis/contacts/company/{company_id}?show_all_anonymized=false&withemail=true&withlinkedin=true&withlegal=true&email_test_status=all&contact_max=50&contact_ids=string' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
successboolean
Example: true
companyobject(Company)
contactsArray of objects(Contact)
contacts_countinteger
metaobject
credits_usedinteger

Number of credits consumed by this request.

Response
application/json
{
  "success": true,
  "company": {
    "id": "593b6fa6b3a2feb79d4f9f39",
    "registration_number": "GB06441592"
  },
  "contacts": [
    { … }
  ],
  "contacts_count": 0,
  "meta": {
    "has_more": true,
    "next_cursor": "string"
  },
  "credits_used": 0
}

Get Single Contact

Request

Retrieve details for a single contact by their ID.

Security
ApiKeyHeader or ApiKeyQuery
Path
contact_idstringrequired

The unique ID of the contact.

curl -i -X GET \
  'https://docs.revealead.com/_mock/apis/contacts/{contact_id}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
successboolean
Example: true
contactobject(Contact)
credits_usedinteger
Example: 1
Response
application/json
{
  "success": true,
  "contact": {
    "id": "8301343831281918940",
    "civility": "Mr",
    "first_name": "James",
    "last_name": "THOMPSON",
    "role": "Chief Technology Officer",
    "level_code": "DIRECTOR",
    "level_label": "Director",
    "domain_code": "TECH",
    "domain_label": "Technology",
    "email": "james.thompson@example.com",
    "email_test_result": "Safe to Send",
    "linkedin_url": "https://www.linkedin.com/in/james-thompson",
    "contact_source": "linkedin",
    "anonymized": false
  },
  "credits_used": 1
}

System

Operations