This endpoint provides the current balance of credits available in your workspace.

Get Current Credit Balance

BearerAuth

Get Current Balance

FullEnrich API Documentation

👋 Welcome to FullEnrich API Documentation

API Overview

Authentication

Credits & Testing Tips

Email Verification Status

Rate Limit

Enrich your contacts using this endpoint.


To enrich a contact, you need at least the firstname, lastname, and either the domain or the company_name. You can also pass the linkedin_url to increase the probability of finding emails and phones.


You can enrich up to 100 contacts in bulk. If you want to enrich only 1 contact, you can pass only 1 contact in the list.


All enrichments started on the API are visible on your FullEnrich dashboard. It is good practice to use a readable 'name' for each enrichment. This way, you can easily search through them. For instance, if you are enriching just one contact, you might name your enrichment 'Firstname Lastname'.


To pass specific properties, utilize the 'custom' field by passing an object. For example, if you are enriching a contact from your CRM, include the CRM 'contact_id' in the custom object. This allows you to reference the contact_id when you receive the result on your webhook. The custom value should be a cast as a string (number will return an error)


To retrieve the results of your enrichment, you can either provide a **webhook URL**[recommended] or call the **GET /bulk/enrichment_id** endpoint [not recommended].

#### How Do Webhooks Work?
Your webhook URL will receive a POST request when the enrichment is finished, lacks credits, or is canceled. If we fail to deliver a result to your webhook (receiving a non-2xx status code), we will retry every minute, up to 5 times. The content sent to your webhook is the same as that provided by the /bulk/enrichment_id endpoint.

Start Bulk Enrichment

Use this endpoint to retrieve the result from an enrich.


You don't need to use this endpoint if you are using a webhook. Using a webhook is the method we recommand to have the result as soon as the enrichment is done. 

Getting Started

API — Enrichment

Get Current Credit Balance

Authorizations

Response