Access and plans
Which plans include API access?
Premium plans. Free and Starter plans don't include API access.
Can I use the API during a trial?
Yes. Accounts in a trial of a qualifying plan can use the API.
My key was working and now returns api_access_not_allowed. Why?
Your key is still valid, but your account no longer qualifies. This happens when a subscription is cancelled, past due or unpaid, or when the account moves to Free or Starter. Access returns once the account is on a qualifying plan and in good standing.
I'm on Free or Starter and can see an API key in my account. Why doesn't it work?
Having a key doesn't grant access on its own. The plan has to include the API as well, so requests return a 403 until you upgrade.
API keys
Where do I find my API key?
In your dashboard, open My Account, click Account Details, then Account Settings. The key is already generated for you.
Can I have more than one key?
No. Each account has one key at a time. Regenerating replaces the existing key.
What happens when I regenerate my key?
You get a new key and the old one is replaced. Update the key anywhere you use it, or those requests will start returning a 401.
I think my key has been exposed. What should I do?
Regenerate it from the same page, then update your integrations with the new key.
Which header should I send the key in?
Either Api-Key: <your key> or Authorization: Bearer <your key>. Both work the same way.
Data and filtering
Can I apply a filter to the API request?
Only a date range, using since and until. You can't filter by profile type or by firmographic details such as industry, employee count or revenue. To narrow results further, pull the date range you need and filter in your own code.
Can I get profiles from more than 90 days ago?
No. since can't be set more than 90 days back. For older history, use the CSV export on the Profiles page.
Do since and until use the first or the last time a visitor was seen?
The last. since returns profiles last seen on or after that date or time, and until returns profiles last seen before it.
What data comes back for each profile?
LinkedIn URL, first name, last name, title, company name, business email, website, industry, employee count, estimated revenue, city, state, zipcode, seen at, referrer, captured URL and tags.
Can I look up one person by email or LinkedIn URL?
No. The API returns a list of your profiles and has no single-profile lookup. Pull the list and match on the Business Email or LinkedIn URL field in your own code.
Can I choose which fields are returned?
No. Every profile comes back with the full set of fields.
Can I add, edit or delete profiles through the API?
No. The API is read-only.
Paging and syncing
How do I pull only the profiles that are new since my last request?
Start again from the first page, without a cursor, and set since to the time of your last pull.
Will I get duplicates or miss profiles if new visitors arrive while I'm paging?
No. Paging is stable. Profiles identified after you start aren't added to later pages, and none get skipped.
How many profiles can I get per request?
100 by default, and up to 250 if you set limit=250.
How do I know when I've reached the end?
next_cursor comes back as null on the last page.
Can I get a total count of profiles?
No. The API doesn't return a total. Keep requesting pages until next_cursor is null.
Can I change the sort order?
No. Results always come back newest first.
Can I build or edit a cursor myself?
No. Cursors are opaque. Pass each next_cursor back exactly as you received it.
Does the API push new profiles to me in real time?
No. The API only returns data when you request it. To have profiles sent to you as they're identified, use the Webhook integration.
Rate limits
What is the rate limit?
20 requests per minute per API key. At limit=250, that's up to 5,000 profiles a minute.
What happens if I go over it?
You get a 429 response with a Retry-After header telling you how many seconds to wait. Wait that long, then continue from the same cursor.
Can I get a higher rate limit?
No. The limit is the same for every key. For large pulls, use the CSV export on the Profiles page.
I need to pull a lot of history. Is the API the right tool?
For a one-off bulk pull, the CSV export on the Profiles page is the better option. The API suits regular, incremental syncs.
Troubleshooting
Why am I getting a 401?
The error value in the response tells you which problem it is:
missing_api_key: no key was sent. Add theApi-KeyorAuthorization: Bearerheader.invalid_api_key_format: the key isn't in the expected format. Copy it again and check for missing characters or extra spaces.invalid_api_key: the key isn't recognised. It may have been deleted or regenerated, so copy the current one from My Account.
Why am I getting a 403 when my key is correct?
A 403 with api_access_not_allowed means the key is valid but the account doesn't qualify for API access. Check that you're on a premium plan and that billing is up to date.
I'm getting a 429 but I'm sending fewer than 20 requests a minute. Why?
There is also a limit of 60 requests per minute from a single IP address, counted across all keys. If you run several keys from one server, their combined traffic can reach it. The limit_per_minute value in the response shows which limit you hit.
My request works in one tool but not another. What should I check?
Check that the tool sends a GET request to https://app.rb2b.com/api/v1/profiles and includes the key in one of the two supported headers. Any tool that can send a GET request with a custom header will work.