### Bulk Contact Enrichment Request Example Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/post Use this example to enrich multiple contacts in a single request. Specify contact details, desired enrichment fields, and optional webhook information. ```yaml openapi: 3.1.0 info: title: FullEnrich API Documentation version: 2.0.0 description: > FullEnrich API enables you to enrich B2B contacts with emails and phone numbers using data from 20+ providers. We are GDPR and CCPA compliant. servers: - url: https://app.fullenrich.com/api/v2 security: [] paths: /contact/enrich/bulk: post: summary: Enrich Contacts In Bulk operationId: postContactBulkEnrich requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestPostContactBulkEnrich' example: name: Sales Operations in London webhook_url: https://example.com/webhook webhook_events: contact_finished: https://example.com/webhook/contact data: - first_name: John last_name: Snow domain: example.com company_name: Example Inc linkedin_url: https://www.linkedin.com/in/demoge/ enrich_fields: - contact.work_emails - contact.personal_emails - contact.phones custom: user_id: '12584' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResponsePostContactBulkEnrich' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: EnrichmentNameNotSet: value: code: error.enrichment.name.empty message: Enrichment name not set WebhookURLInvalid: value: code: error.enrichment.webhook_url message: Webhook URL must be start with http or https ProviderNotSet: value: code: error.enrichment.provider.empty message: Providers not set DataNotSet: value: code: error.enrichment.data.empty message: Data is empty FirstNameNotSet: value: code: error.enrichment.first_name.empty message: First name cannot be empty LastNameNotSet: value: code: error.enrichment.last_name.empty message: Last name cannot be empty DomainNotSet: value: code: error.enrichment.domain.empty message: Domain cannot be empty EnrichFieldsNotSet: value: code: error.enrichment.enrich_fields.empty message: enrichFields cannot be empty EnrichFieldValue: value: code: error.enrichment.enrich_field.value message: >- enrichField 'xxxx' not valid must be contact.work_emails or contact.phones or contact.personal_emails CustomKeyExceeded: value: code: error.enrichment.custom.key.exceeded message: 'Custom field contains too many keys (max: 10 keys)' CustomKeyValueExceeded: value: code: error.enrichment.custom.value.exceeded message: 'Custom field value max len exceeded (max: 100 character)' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' examples: AuthorizationHeaderNotSet: value: code: error.authorization.not_set message: Authorization headers not set AuthorizationHeaderNotAnBearer: value: code: error.authorization.not_bearer message: Authorization headers do not have prefix 'bearer' UnknownApiKey: value: code: error.api.key message: Unknown api key '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/Error' examples: RateLimitExceeded: value: code: error.rate.limit message: Too many requests. Try again in 1m security: - BearerAuth: [] components: schemas: ``` -------------------------------- ### Error Response Examples Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/post Examples of common error responses for the bulk contact enrichment endpoint, including validation errors and authorization issues. ```json { "code": "error.enrichment.name.empty", "message": "Enrichment name not set" } ``` ```json { "code": "error.enrichment.webhook_url", "message": "Webhook URL must be start with http or https" } ``` ```json { "code": "error.enrichment.provider.empty", "message": "Providers not set" } ``` ```json { "code": "error.enrichment.data.empty", "message": "Data is empty" } ``` ```json { "code": "error.enrichment.first_name.empty", "message": "First name cannot be empty" } ``` ```json { "code": "error.enrichment.last_name.empty", "message": "Last name cannot be empty" } ``` ```json { "code": "error.enrichment.domain.empty", "message": "Domain cannot be empty" } ``` ```json { "code": "error.enrichment.enrich_fields.empty", "message": "enrichFields cannot be empty" } ``` ```json { "code": "error.enrichment.enrich_field.value", "message": "enrichField 'xxxx' not valid must be contact.work_emails or contact.phones or contact.personal_emails" } ``` ```json { "code": "error.enrichment.custom.key.exceeded", "message": "Custom field contains too many keys (max: 10 keys)" } ``` ```json { "code": "error.enrichment.custom.value.exceeded", "message": "Custom field value max len exceeded (max: 100 character)" } ``` ```json { "code": "error.authorization.not_set", "message": "Authorization headers not set" } ``` ```json { "code": "error.authorization.not_bearer", "message": "Authorization headers do not have prefix 'bearer'" } ``` ```json { "code": "error.api.key", "message": "Unknown api key" } ``` ```json { "code": "error.rate.limit", "message": "Too many requests. Try again in 1m" } ``` -------------------------------- ### Start Bulk Enrichment Source: https://docs.fullenrich.com/llms.txt Initiates a bulk enrichment process for contacts. ```APIDOC ## POST /v2/contact/enrich/bulk ### Description Starts a bulk enrichment process for contacts. ### Method POST ### Endpoint /v2/contact/enrich/bulk ``` -------------------------------- ### Get Credit Balance Source: https://docs.fullenrich.com/llms.txt Retrieves the current balance of credits available in your workspace. ```APIDOC ## GET /v2/account/credits/get ### Description This endpoint provides the current balance of credits available in your workspace. ### Method GET ### Endpoint /v2/account/credits/get ``` -------------------------------- ### OpenAPI Specification for Get Credit Balance Source: https://docs.fullenrich.com/api/v2/account/credits/get This OpenAPI 3.1.0 specification defines the GET /account/credits endpoint, which retrieves the current credit balance. It includes details on request, responses, and security schemes. ```yaml openapi: 3.1.0 info: title: FullEnrich API Documentation version: 2.0.0 description: > FullEnrich API enables you to enrich B2B contacts with emails and phone numbers using data from 20+ providers. We are GDPR and CCPA compliant. servers: - url: https://app.fullenrich.com/api/v2 security: [] paths: /account/credits: get: summary: Get Current Balance description: >- This endpoint provides the current balance of credits available in your workspace. operationId: getAccountCredits responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Credits' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' examples: AuthorizationHeaderNotSet: value: code: error.authorization.not_set message: Authorization headers not set AuthorizationHeaderNotAnBearer: value: code: error.authorization.not_bearer message: Authorization headers do not have prefix 'bearer' UnknownApiKey: value: code: error.api.key message: Unknown api key '404': description: Workspace ID not found security: - BearerAuth: [] components: schemas: Credits: type: object properties: balance: type: number format: double description: Number of credits available on your workspace examples: - 5000 Error: type: object properties: code: type: string message: type: string required: - code - message securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: string ``` -------------------------------- ### OpenAPI Specification for Bulk Reverse Email Lookup Source: https://docs.fullenrich.com/api/v2/contact/reverse/email/bulk/get This OpenAPI 3.1.0 specification defines the GET endpoint for retrieving bulk reverse email lookup results. It outlines the request parameters, response structure, and provides an example of a successful response. ```yaml openapi: 3.1.0 info: title: FullEnrich API Documentation version: 2.0.0 description: > FullEnrich API enables you to enrich B2B contacts with emails and phone numbers using data from 20+ providers. We are GDPR and CCPA compliant. servers: - url: https://app.fullenrich.com/api/v2 security: [] paths: /contact/reverse/email/bulk/{enrichment_id}: get: summary: Get Bulk Reverse Email Results description: Use this endpoint to retrieve the result from a reverse email lookup. operationId: GetContactBulkReverseEmailByID parameters: - name: enrichment_id in: path required: true description: The unique identifier returned when the reverse lookup was started schema: type: string example: 2db5ea61-1752-42cf-8ea1-ab1da060cd0a responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResponseGetContactBulkReverseEmail' example: id: 2db5ea61-1752-42cf-8ea1-ab1da060cd0a name: Reverse Email Lookup status: FINISHED cost: credits: 1 data: - input: email: johnsnow@gmail.com custom: user_id: '12584' profile: id: 746e4816-19c8-54d8-b558-65a5a52cc85c full_name: John Snow first_name: John last_name: Snow location: country: United States country_code: US city: San Francisco region: California social_profiles: professional_network: url: https://www.linkedin.com/in/demoge/ handle: demoge connection_count: 500 educations: - school_name: Stanford University degree: Bachelor of Science in Computer Science start_at: '2015-09-01T00:00:00Z' end_at: '2019-06-01T00:00:00Z' languages: - language: English proficiency: PROFESSIONAL_WORKING - language: French proficiency: NATIVE_OR_BILINGUAL skills: - Sales Operations - Business Development - CRM Management employment: current: title: Head of Sales Operations is_current: true start_at: '2022-03-15T00:00:00Z' company: id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 name: Example Inc domain: example.com description: Leading example company year_founded: 2010 headcount: 250 company_type: Privately Held locations: headquarters: line1: 123 Market St line2: San Francisco, CA 94105, US city: San Francisco region: California country: United States country_code: US offices: - line1: 456 Broadway line2: New York, NY 10013, US industry: main_industry: Software Development social_profiles: professional_network: url: https://www.linkedin.com/company/example-inc handle: example-inc connection_count: 12000 all: - title: Head of Sales Operations is_current: true start_at: '2022-03-15T00:00:00Z' company: id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 name: Example Inc domain: example.com description: Leading example company year_founded: 2010 ``` -------------------------------- ### Get Current Balance Source: https://docs.fullenrich.com/api/v2/account/credits/get Fetches the current credit balance for the authenticated workspace. This is useful for monitoring usage and planning. ```APIDOC ## GET /account/credits ### Description This endpoint provides the current balance of credits available in your workspace. ### Method GET ### Endpoint /account/credits ### Parameters ### Request Body ### Response #### Success Response (200) - **balance** (number) - Number of credits available on your workspace #### Response Example { "balance": 5000 } ``` -------------------------------- ### Webhook Event Payload Example Source: https://docs.fullenrich.com/api/v2/general/webhooks This JSON payload represents the data received when a profile is enriched. The 'status' field indicates that processing is ongoing for individual contacts. ```json { "id": "", "name": "", "status": "IN_PROGRESS", "cost": { "credits": 10 }, "data": [ { "input": { "first_name": "", "last_name": "", "full_name": "", "company_domain": "", "company_name": "", "professional_network_url": "" }, "custom": {}, "contact_info": { "most_probable_work_email": { "email": "", "status": "DELIVERABLE" }, "most_probable_personal_email": { "email": "", "status": "DELIVERABLE" }, "most_probable_phone": { "number": "", "region": "" }, "work_emails": [ { "email": "", "status": "DELIVERABLE" } ], "personal_emails": [ { "email": "", "status": "DELIVERABLE" } ], "phones": [ { "number": "", "region": "" } ] }, "profile": { "id": "", "full_name": "", "first_name": "", "last_name": "", "location": { "country": "", "country_code": "", "city": "", "region": "" }, "social_profiles": { ... }, "educations": [{ ... }], "languages": [{ ... }], "skills": [""], "employment": { ... } } } ] } ``` -------------------------------- ### OpenAPI Specification for API Key Verification Source: https://docs.fullenrich.com/api/v2/account/keys/verify/get This OpenAPI 3.1.0 specification defines the GET /account/keys/verify endpoint. It details the request, successful responses (200 OK), and various error responses (401 Unauthorized, 404 Not Found). ```yaml openapi: 3.1.0 info: title: FullEnrich API Documentation version: 2.0.0 description: > FullEnrich API enables you to enrich B2B contacts with emails and phone numbers using data from 20+ providers. We are GDPR and CCPA compliant. servers: - url: https://app.fullenrich.com/api/v2 security: [] paths: /account/keys/verify: get: summary: Check If API Key Is Valid description: This endpoint checks if your API key is valid. operationId: checkKey responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/verifyKey' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' examples: AuthorizationHeaderNotSet: value: code: error.authorization.not_set message: Authorization headers not set AuthorizationHeaderNotAnBearer: value: code: error.authorization.not_bearer message: Authorization headers do not have prefix 'bearer' UnknowApiKey: value: code: error.api.key message: Unknown api key '404': description: Workspace ID not found security: - BearerAuth: [] components: schemas: verifyKey: type: object description: Response returned when API key is valid properties: workspace_id: type: string description: The workspace ID associated with this API key example: 2db5ea61-1752-42cf-8ea1-ab1da060cd0a Error: type: object properties: code: type: string message: type: string required: - code - message securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: string ``` -------------------------------- ### OpenAPI Specification for Bulk Reverse Email Lookup Source: https://docs.fullenrich.com/api/v2/contact/reverse/email/bulk/post This OpenAPI 3.1.0 specification defines the structure and behavior for the POST /contact/reverse/email/bulk endpoint. It includes request body schemas, response schemas, and error examples. ```yaml openapi: 3.1.0 info: title: FullEnrich API Documentation version: 2.0.0 description: > FullEnrich API enables you to enrich B2B contacts with emails and phone numbers using data from 20+ providers. We are GDPR and CCPA compliant. servers: - url: https://app.fullenrich.com/api/v2 security: [] paths: /contact/reverse/email/bulk: post: summary: Reverse Contact Lookup In Bulk operationId: postContactBulkReverseEmail requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestPostContactBulkReverseEmail' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResponsePostContactBulkReverseEmail' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: ReverseEmailInvalid: value: code: error.reverse.email.invalid message: Email is invalid ReverseEmailNotSet: value: code: error.reverse.email.empty message: Email cannot be empty WebhookURLInvalid: value: code: error.enrichment.webhook_url message: Webhook URL must be start with http or https '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' examples: AuthorizationHeaderNotSet: value: code: error.authorization.not_set message: Authorization headers not set AuthorizationHeaderNotAnBearer: value: code: error.authorization.not_bearer message: Authorization headers do not have prefix 'bearer' UnknownApiKey: value: code: error.api.key message: Unknown api key security: - BearerAuth: [] components: schemas: RequestPostContactBulkReverseEmail: type: object properties: name: type: string description: A readable name for this reverse lookup (visible in your dashboard) example: Reverse Lookup Batch 1 webhook_url: type: string description: >- URL that will receive a POST request when the entire reverse lookup is finished (all emails processed). example: https://example.com/webhook webhook_events: type: object description: Optional webhook URLs for specific events during reverse lookup properties: contact_finished: type: string description: >- URL that receives a POST request each time a single email is processed, without waiting for the entire batch to complete. example: https://example.com/webhook/contact data: type: array items: type: object properties: email: type: string description: Email address to perform reverse lookup on example: john.snow@example.com custom: type: object description: >- Custom fields returned in the result (max 10 keys, 100 chars per value) example: user_id: '12584' required: - email example: - email: john.snow@example.com custom: user_id: '12584' required: - name - providers - data ResponsePostContactBulkReverseEmail: type: object properties: enrichment_id: type: string format: uuid examples: - 2db5ea61-1752-42cf-8ea1-ab1da060cd0a Error: type: object properties: code: type: string message: type: string required: - code - message securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: string ``` -------------------------------- ### OpenAPI Specification for Get Bulk Enrich Results Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/get This OpenAPI 3.1.0 specification defines the GET /contact/enrich/bulk/{enrichment_id} endpoint for retrieving bulk enrich results. It includes parameters, response schemas, and an example response. ```yaml openapi: 3.1.0 info: title: FullEnrich API Documentation version: 2.0.0 description: > FullEnrich API enables you to enrich B2B contacts with emails and phone numbers using data from 20+ providers. We are GDPR and CCPA compliant. servers: - url: https://app.fullenrich.com/api/v2 security: [] paths: /contact/enrich/bulk/{enrichment_id}: get: summary: Get Bulk Enrich Results description: Use this endpoint to retrieve the result from an enrich. operationId: GetContactBulkEnrichByID parameters: - name: enrichment_id in: path required: true description: The unique identifier returned when the enrichment was started schema: type: string example: 2db5ea61-1752-42cf-8ea1-ab1da060cd0a - name: forceResults in: query schema: type: boolean description: >- Default = False. This parameter forces the API to return what has been found so far, even if the enrichment is not finished. This may result in missing information and is not recommended for regular use. responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResponseGetContactBulkEnrich' example: id: 2db5ea61-1752-42cf-8ea1-ab1da060cd0a name: Sales Operations in London status: FINISHED cost: credits: 14 data: - input: first_name: John last_name: Snow company_domain: example.com company_name: Example Inc professional_network_url: https://www.linkedin.com/in/demoge/ custom: user_id: '12584' contact_info: most_probable_work_email: email: john.snow@example.com status: DELIVERABLE most_probable_personal_email: email: johnsnow@gmail.com status: DELIVERABLE most_probable_phone: number: '+1 555-123-4567' region: US work_emails: - email: john.snow@example.com status: DELIVERABLE personal_emails: - email: johnsnow@gmail.com status: DELIVERABLE phones: - number: '+1 555-123-4567' region: US - number: '+33 6 12 34 56 78' region: FR profile: id: 746e4816-19c8-54d8-b558-65a5a52cc85c full_name: John Snow first_name: John last_name: Snow location: country: United States country_code: US city: San Francisco region: California social_profiles: professional_network: id: 1234 url: https://www.linkedin.com/in/john-doe handle: john-doe connection_count: 500 educations: - school_name: Stanford University degree: Bachelor of Science in Computer Science start_at: '2015-09-01T00:00:00Z' end_at: '2019-06-01T00:00:00Z' languages: - language: English proficiency: PROFESSIONAL_WORKING - language: French proficiency: NATIVE_OR_BILINGUAL skills: - Sales Operations - Business Development - CRM Management employment: current: title: Head of Sales Operations is_current: true start_at: '2022-03-15T00:00:00Z' company: id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 name: Example Inc domain: example.com description: Leading example company year_founded: 2010 headcount: 250 ``` -------------------------------- ### Get Bulk Reverse Email Results by ID Source: https://docs.fullenrich.com/api/v2/contact/reverse/email/bulk/get Fetches the results of a bulk reverse email lookup operation. You need to provide the enrichment ID that was returned when the lookup was initially started. ```APIDOC ## GET /contact/reverse/email/bulk/{enrichment_id} ### Description Use this endpoint to retrieve the result from a reverse email lookup. ### Method GET ### Endpoint /contact/reverse/email/bulk/{enrichment_id} ### Parameters #### Path Parameters - **enrichment_id** (string) - Required - The unique identifier returned when the reverse lookup was started ### Response #### Success Response (200) - **id** (string) - The unique identifier for the enrichment process. - **name** (string) - The name of the enrichment operation. - **status** (string) - The current status of the enrichment process (e.g., FINISHED). - **cost** (object) - Information about the cost of the enrichment. - **credits** (integer) - The number of credits consumed. - **data** (array) - An array of results for each input email. - **input** (object) - The original input for the lookup. - **email** (string) - The email address that was looked up. - **custom** (object) - Custom fields associated with the lookup. - **user_id** (string) - A custom user identifier. - **profile** (object) - Detailed profile information for the contact. - **id** (string) - The unique identifier for the contact profile. - **full_name** (string) - The full name of the contact. - **first_name** (string) - The first name of the contact. - **last_name** (string) - The last name of the contact. - **location** (object) - Location details of the contact. - **country** (string) - The country. - **country_code** (string) - The country code. - **city** (string) - The city. - **region** (string) - The region or state. - **social_profiles** (object) - Social media profiles. - **professional_network** (object) - LinkedIn profile details. - **url** (string) - The URL of the LinkedIn profile. - **handle** (string) - The LinkedIn handle. - **connection_count** (integer) - The number of connections. - **educations** (array) - List of educational background. - **school_name** (string) - The name of the educational institution. - **degree** (string) - The degree obtained. - **start_at** (string) - The start date of education. - **end_at** (string) - The end date of education. - **languages** (array) - Languages spoken by the contact. - **language** (string) - The language name. - **proficiency** (string) - The proficiency level. - **skills** (array) - List of skills. - **skill** (string) - A skill possessed by the contact. - **employment** (object) - Employment history. - **current** (object) - Details about the current employment. - **title** (string) - The job title. - **is_current** (boolean) - Indicates if this is the current job. - **start_at** (string) - The start date of employment. - **company** (object) - Details about the current company. - **id** (string) - The company ID. - **name** (string) - The company name. - **domain** (string) - The company domain. - **description** (string) - A description of the company. - **year_founded** (integer) - The year the company was founded. - **headcount** (integer) - The number of employees. - **company_type** (string) - The type of company (e.g., Privately Held). - **locations** (object) - Company location details. - **headquarters** (object) - Headquarters address. - **line1** (string) - Address line 1. - **line2** (string) - Address line 2. - **city** (string) - City. - **region** (string) - Region or state. - **country** (string) - Country. - **country_code** (string) - Country code. - **offices** (array) - List of other company offices. - **line1** (string) - Address line 1. - **line2** (string) - Address line 2. - **city** (string) - City. - **region** (string) - Region or state. - **country** (string) - Country. - **country_code** (string) - Country code. - **industry** (object) - Industry information. - **main_industry** (string) - The primary industry. - **social_profiles** (object) - Company social profiles. - **professional_network** (object) - LinkedIn company profile. - **url** (string) - The URL of the LinkedIn page. - **handle** (string) - The LinkedIn handle. - **connection_count** (integer) - The number of followers/connections. - **all** (array) - A list of all past and present employment records. - **title** (string) - The job title. - **is_current** (boolean) - Indicates if this is the current job. - **start_at** (string) - The start date of employment. - **company** (object) - Details about the company. - **id** (string) - The company ID. - **name** (string) - The company name. - **domain** (string) - The company domain. - **description** (string) - A description of the company. - **year_founded** (integer) - The year the company was founded. ### Request Example (No request body for GET requests) ### Response Example ```json { "id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a", "name": "Reverse Email Lookup", "status": "FINISHED", "cost": { "credits": 1 }, "data": [ { "input": { "email": "johnsnow@gmail.com" }, "custom": { "user_id": "12584" }, "profile": { "id": "746e4816-19c8-54d8-b558-65a5a52cc85c", "full_name": "John Snow", "first_name": "John", "last_name": "Snow", "location": { "country": "United States", "country_code": "US", "city": "San Francisco", "region": "California" }, "social_profiles": { "professional_network": { "url": "https://www.linkedin.com/in/demoge/", "handle": "demoge", "connection_count": 500 } }, "educations": [ { "school_name": "Stanford University", "degree": "Bachelor of Science in Computer Science", "start_at": "2015-09-01T00:00:00Z", "end_at": "2019-06-01T00:00:00Z" } ], "languages": [ { "language": "English", "proficiency": "PROFESSIONAL_WORKING" }, { "language": "French", "proficiency": "NATIVE_OR_BILINGUAL" } ], "skills": [ "Sales Operations", "Business Development", "CRM Management" ], "employment": { "current": { "title": "Head of Sales Operations", "is_current": true, "start_at": "2022-03-15T00:00:00Z", "company": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Example Inc", "domain": "example.com", "description": "Leading example company", "year_founded": 2010, "headcount": 250, "company_type": "Privately Held", "locations": { "headquarters": { "line1": "123 Market St", "line2": "San Francisco, CA 94105, US", "city": "San Francisco", "region": "California", "country": "United States", "country_code": "US" }, "offices": [ { "line1": "456 Broadway", "line2": "New York, NY 10013, US" } ] }, "industry": { "main_industry": "Software Development" }, "social_profiles": { "professional_network": { "url": "https://www.linkedin.com/company/example-inc", "handle": "example-inc", "connection_count": 12000 } } } }, "all": [ { "title": "Head of Sales Operations", "is_current": true, "start_at": "2022-03-15T00:00:00Z", "company": { "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "name": "Example Inc", "domain": "example.com", "description": "Leading example company", "year_founded": 2010 } } ] } } } ] } ``` ``` -------------------------------- ### GET /api/v2/contact/enrich/bulk/{id} Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/get Retrieves the status and results of a bulk contact enrichment job. You need to provide the unique ID of the enrichment job to get its details. ```APIDOC ## GET /api/v2/contact/enrich/bulk/{id} ### Description Retrieves the status and results of a bulk contact enrichment job. You need to provide the unique ID of the enrichment job to get its details. ### Method GET ### Endpoint /api/v2/contact/enrich/bulk/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the bulk enrichment job. #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **id** (string) - The unique identifier of the enrichment job. - **name** (string) - The name of the enrichment job. - **status** (string) - The current status of the enrichment job. Possible values include CREATED, IN_PROGRESS, CANCELED, CREDITS_INSUFFICIENT, FINISHED, RATE_LIMIT, UNKNOWN. - **data** (array) - An array of enriched contact records. - **input** (object) - The original input data provided for this contact. - **first_name** (string) - First name of the contact. - **last_name** (string) - Last name of the contact. - **full_name** (string) - Full name of the contact. - **company_domain** (string) - Domain of the contact's company. - **company_name** (string) - Name of the contact's company. - **linkedin_url** (string) - LinkedIn profile URL of the contact. - **custom** (object) - Custom fields passed during enrichment request, returned unchanged. - **contact_info** (object) - Contact information found during enrichment. - **most_probable_work_email** (object) - The most reliable work email found. - **most_probable_personal_email** (object) - The most reliable personal email found. - **most_probable_phone** (object) - The most reliable mobile phone number found. - **work_emails** (array) - All work emails found. - **profile** (object) - Full professional profile of the person (returned when linkedin_url was provided). - **cost** (object) - Information about the credits consumed for this enrichment. - **credits** (integer) - Number of credits consumed for this enrichment. #### Response Example ```json { "id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a", "name": "Sales Operations in London", "status": "FINISHED", "data": [ { "input": { "first_name": "John", "last_name": "Snow", "company_domain": "example.com" }, "custom": { "user_id": "12584" }, "contact_info": { "most_probable_work_email": { "email": "john.snow@example.com", "type": "work" }, "work_emails": [ { "email": "john.snow@example.com", "type": "work" } ] }, "profile": { "name": "John Snow", "headline": "Sales Operations Manager at Example Inc.", "linkedin_url": "https://www.linkedin.com/in/johndoe" } } ], "cost": { "credits": 1 } } ``` ### Error Handling - **400 Bad Request**: Invalid request parameters. - **401 Unauthorized**: Authentication failed. Ensure your API key is valid and included in the Authorization header. - **402 Payment Required**: Payment is required to access this resource. Your account may have insufficient credits. - **404 Not Found**: The specified enrichment ID was not found. - **429 Too Many Requests**: Rate limit exceeded. Please try again later. ``` -------------------------------- ### Check If API Key Is Valid Source: https://docs.fullenrich.com/llms.txt Verifies the validity of your provided API key. ```APIDOC ## GET /v2/account/keys/verify ### Description This endpoint checks if your API key is valid. ### Method GET ### Endpoint /v2/account/keys/verify ``` -------------------------------- ### POST /api/v2/contact/enrich/bulk Source: https://docs.fullenrich.com/api/v2/contact/enrich/bulk/post Initiates a bulk contact enrichment process. Provide a list of contacts with desired enrichment fields and optional webhook configurations. ```APIDOC ## POST /api/v2/contact/enrich/bulk ### Description Initiates a bulk contact enrichment process. Provide a list of contacts with desired enrichment fields and optional webhook configurations. ### Method POST ### Endpoint /api/v2/contact/enrich/bulk ### Request Body - **name** (string) - Required - A readable name for this enrichment (visible in your dashboard) - **webhook_url** (string) - Optional - URL that will receive a POST request when the entire enrichment is finished (all contacts processed). - **webhook_events** (object) - Optional - Optional webhook URLs for specific events during enrichment - **contact_finished** (string) - Optional - URL that receives a POST request each time a single contact is enriched, without waiting for the entire batch to complete. Useful for real-time updates. - **data** (array) - Required - An array of contact objects to enrich. - **first_name** (string) - Optional - The first name of the contact. - **last_name** (string) - Optional - The last name of the contact. - **domain** (string) - Optional - The domain of the contact's company. - **company_name** (string) - Optional - The name of the contact's company. - **linkedin_url** (string) - Optional - Supports standard LinkedIn profile URLs as well as LinkedIn Sales Navigator URLs. - **enrich_fields** (array) - Optional - A list of fields to enrich for the contact. Possible values: `contact.work_emails`, `contact.phones`, `contact.personal_emails`. - **custom** (object) - Optional - Returned in the enrichment result. Use it to identify a user, a CRM contact, or to pass any other information. All values must be strings. Limited to 20 entries. ### Request Example ```json { "name": "Sales Operations in London", "webhook_url": "https://example.com/webhook", "webhook_events": { "contact_finished": "https://example.com/webhook/contact" }, "data": [ { "first_name": "John", "last_name": "Snow", "domain": "example.com", "company_name": "Example Inc", "linkedin_url": "https://www.linkedin.com/in/demoge/", "enrich_fields": [ "contact.work_emails", "contact.personal_emails", "contact.phones" ], "custom": { "user_id": "12584" } } ] } ``` ### Response #### Success Response (200) - **enrichment_id** (string) - The unique identifier for this enrichment process. #### Response Example ```json { "enrichment_id": "2db5ea61-1752-42cf-8ea1-ab1da060cd0a" } ``` #### Error Response - **code** (string) - An error code. - **message** (string) - A human-readable error message. #### Error Response Example ```json { "code": "INVALID_REQUEST", "message": "The request body is invalid." } ``` ``` -------------------------------- ### Get Reverse Email Result Source: https://docs.fullenrich.com/llms.txt Retrieves the result from a reverse email lookup process. ```APIDOC ## GET /v2/contact/reverse/email/bulk ### Description Use this endpoint to retrieve the result from a reverse email lookup. ### Method GET ### Endpoint /v2/contact/reverse/email/bulk ```