Quick start

Surfe API gets you all the information you need for the next account you want to close. Let's get you set up swiftly!

Surfe's API uses a user-specific API Key for authentication, which you can manage through the Surfe dashboard. Once you have your key, just include it in the Authorization header (Bearer {api-key}) when making requests.

Set up the API

Create a Surfe account

Go to API Settings, if you don't have a Surfe account, you'll be asked to create one. You can connect with your CRM or GMail address.

Image

Get your API Key

In the API settings, generate the key. Image

Jump right in!

You're good to go!

Image

You can start by querying a person's information:

curl -X POST "https://api.surfe.com/v1/people/enrichments" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "enrichmentType": "email",
    "person": {
      "linkedinUrl": "https://www.linkedin.com/in/david-maurice-chevalier/"
    }
  }'

Most used endpoints

Good to Know

Credits

There are 2 types of credits—one for emails, another for mobiles. To see how many credits you have left, head over to Surfe App. You can buy more credits through this link

If you run out or exceed your daily allowance, Surfe returns a 403 Forbidden (insufficient credits) or 429 Too Many Requests (over quota).

Daily Quotas

Endpoints generally allow 2,000 requests/day. See here for more detail about quotas.

Quotas reset daily at midnight (user's local time).

Contact us if you need higher limits, we'll be happy to accomodate!

Rate Limits

Up to 10 requests per second, with bursts up to 20.

Surfe returns 429 Too Many Requests if this is exceeded.

Responses

Surfe uses standard HTTP codes: 2xx (success), 4xx/5xx (errors).

All output is JSON, with code and message fields for clarity.

On this page