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:

  1. Resource Endpoints. These endpoints give you Crossbeam resources, like user data, your list of partners, populations, etc.

  2. 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

/v0.1/populations

a list of your populations

none

Partners

Get all of your partners

/v0.1/partners

a list of your partners

none

Partner-Populations

Get all of your partner's populations

/v0.1/partner-populations

a list of your partner's populations that are shared with you

none

Reports

Get all of your reports

/v0.2/reports

a list of your Reports

none

View all Threads

Get all of your threads

/v0.1/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

/v0.1/threads/:thread-id/timeline

all activity for a given thread, specified by thread-id

thread-id

Universal Search

Find a specific record (company, person), population, partner, or partner population

/v0.1/search

a record, population, partner, partner population that closely matches your search parameter

search

Get your own user data

Get your user data and which organizations you belong to

/v0.1/users/me

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

/v0.1/partner-records/search

the partners and their populations that overlap, as well as data shared from the partner (excluding contacts and opportunities)

domain or email

Single company overlaps

Get overlaps across your partners for a specific company

/v0.1/partner-records/company/:id

the partners and their populations that overlap, as well as data shared from the partner (excluding contacts and opportunities)

record_id

Single person overlaps

Get overlaps across your partners for a specific person

/v0.1/partner-records/person/:id

the partners and their populations that overlap, as well as data shared from the partner (excluding contacts and opportunities)

record_id

All overlaps

Get all partner data from all overlapping partner about all accounts/leads.

/v0.1/partner-records

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

/v0.1/reports/:report-id/data

all records in the report and data included in visible report columns

report_id

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).

Did this answer your question?