Crossbeam offers a powerful REST API to programmatically extract data from the platform.
Below is an overview of the different endpoints available in the API. Detailed developer documentation is available at developers.crossbeam.com.
There are two types of endpoints:
Resource Endpoints. These endpoints give you Crossbeam resources, like user data, your list of partners, populations, etc.
Overlap Endpoints. These endpoints give you back overlaps that Crossbeam has identified between you and your partners.
Resource Endpoints
These endpoints give you Crossbeam resources, like user data, your list of populations, partners, reports, threads, etc.
| Description | Docs | Returns | Parameters |
Populations | Get all of your populations | a list of your populations | none | |
Partners | Get all of your partners | a list of your partners | none | |
Partner-Populations | Get all of your partner's populations | a list of your partner's populations that are shared with you | none | |
Reports | Get all of your reports | a list of your Reports | none | |
View all Threads | Get all of your threads | a list of any Threads where you are an owner | none | |
View a single Thread | Get a timeline of activity for a single Thread | all activity for a given thread, specified by thread-id |
| |
Universal Search | Find a specific record (company, person), population, partner, or partner population | a record, population, partner, partner population that closely matches your search parameter |
| |
Get your own user data | Get your user data and which organizations you belong to | your user data, including name, email, roles, and organizations you belong to | none |
Overlap Endpoints
These endpoints give you back overlaps that Crossbeam has identified between you and your partners.
| Description | Docs | Returns | Parameters |
Search for overlaps by email or company domain | Get overlaps across your partners for a person or company | the partners and their populations that overlap, as well as data shared from the partner (excluding contacts and opportunities) |
| |
Single company overlaps | Get overlaps across your partners for a specific company | the partners and their populations that overlap, as well as data shared from the partner (excluding contacts and opportunities) |
| |
Single person overlaps | Get overlaps across your partners for a specific person | the partners and their populations that overlap, as well as data shared from the partner (excluding contacts and opportunities) |
| |
All overlaps | Get all partner data from all overlapping partner about all accounts/leads. | all records that have an overlap and the partners and their populations that overlap, as well as data shared from the partner (excluding contacts and opportunities) |
| |
Report data | Get overlaps included in a specific report | all records in the report and data included in visible report columns |
|
API Developer Documentation
API documentation can be found here.
How do I get access to the API?
Currently, access to the Crossbeam REST API is only available to enterprise customers.
Reach out to your CSM or sales rep, contact us via the chat bubble in-app, or contact us at support@crossbeam.com to discuss your current plan and request access.
How do I authenticate with the API?
Once your organization has access to the API, you will see a new section on the Integrations page in Crossbeam. Further instructions for authenticating can be found in our developer documentation (see below).
