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 your API
Get your API Key
Go to your dashboard and generate the key.
Jump right in!
You can start by querying a contact's information:
You can consult all other endpoints in the sidebar section
Most used endpoints
Search for contacts
Input your persona filters and get a list of contacts that fit the criteria.
Enrich contacts
Input a list of users and get their email, mobile numbers and LinkedIn information.
Search for companies
Input your ICP filters and get a list of companies that fit the criteria.
Get company lookalikes
Input a company and get a list of related companies.
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.