Overview
Get an overview of the Beamery API, including environment URLs, API structure, and key information you need to know before making your first request.
API Description
The Beamery API is used to manage and enhance contact information with endpoints to create, read, update or delete contacts from the Beamery platform. Our API is RESTful and responses delivered in JSON format. The Beamery API supports SSL, and as such all requests must be made using the HTTPS protocol.
The Beamery API can be run by any authenticated user in the system as long as they have the privileges to do so.
API URLs
Environment | URL | Notes |
|---|---|---|
Production US | https://frontier.beamery.com/v1 | — |
Sandbox US | https://frontier.sandbox.beamery.com/v1 | — |
Production EU | https://frontier.beamery.eu/v1 | EMEA clients have both sandbox and production here |
Please confirm which environment your tenant is on with your Customer Success Manager (CSM) before attempting to use our Public API.
URL Structure
You will need to suffix the above urls with /v1 whenever using a call. For example, if making a call to the /users endpoint on the sandbox environment, your full request url should be:
https://frontier.sandbox.beamery.com/v1/endpoint
In order to work with the API you will need a Beamery user with the API user role ACL. Reach out to your CSM for support in creating the user.
Authentication
All API requests require authentication using OAuth 2.0. Before making any API calls, you'll need to obtain proper credentials and understand our authentication flow.
Next Steps
Now that you understand the basics: