How can we help?

Allbound's Open API

Teresa
Teresa
  • Updated

Purpose Statement

This article is intended to provide an overview of Allbound's Open API to developers and technical teams.

Introduction

Allbound's Open API allows you to integrate your tech stack with Allbound. Whether you want to fetch data from Allbound or push data to Allbound, our Open API allows you to perform the same basic functions that users can perform in the user interface(UI) and is designed to meet the diverse needs of developers and businesses. Among its attributes are:

  • Rest API
  • Comprehensive documentation:
  • Ability to self-provision secure credentials
  • Ability to edit permissions/scopes per credential
  • Ability to revoke credentials

To get this add-on feature, please reach out to your CSM.

Note: In addition to our Open API, we also support:

 

The sections below outline our current Open API functionality and planned roadmap items. As endpoints are added, this document will be updated accordingly. If you are interested in an API endpoint that is currently not available, please email the Allbound Product Team at feedback@allbound.com to provide your use case and request an endpoint. 

Authorization

If your portal has the Open API add-on feature enabled, then you will have the ability to self-provision your Open API credentials.

Create Credentials

To provision credentials, System Admins:

  1. Navigate to Allbound Settings > Advanced Settings.
  2. Click on Open API > Authentication in the left hand navigation.
  3. Click + Credentials. You will be prompted to select the type of credentials to create.
  4. Select Create API Key to provision an API Key or select Create Credentials to provision OAuth client key and secret. 
  5. Populate the side modal with the appropriate values.
  6. Click Save.
  7. Allbound will generate and display your API Key or OAuth Client Key and Client Secret. Save these credentials in a secure location since you will not able to view them again once you close the modal. 

Edit Permissions

To edit the permissions (or scopes) of an existing credentials, click on the kebab menu and click Edit Permission

editPermissions.png

The side modal will populate all existing Permissions assigned to that credential. Select additional permissions to increase scopes or delete existing permissions to reduce scopes. 

Note: As a reminder, each "manage" permission includes full system-admin permissions (when supported by an endpoint):

  • Create permission
  • Read permission
  • Update permission
  • Delete permission

editPermsModal.png

Revoke Credentials

If you forget your credentials and need to create a new one (and delete the old one) or you want to simply revoke existing credentials so that they can no longer access Allbound, you may revoke credentials as follows:

  1. On the kebab menu for the credential you want to revoke, select Revoke.
  2. A modal will be displayed for you to confirm the revoke. Once revoked, the credentials cannot be reinstated. Click Confirm to permanently delete the credentials and revoke all access.

revokeCredentials.png

Companies

The Companies related API endpoints provide full CRUD (create, read, update, delete) functionality for company management to API consumers.

API Endpoint Permission Required Comments
GET List company fields companies.read or companies.manage Returns a list of all fields on the customizable Company Admin form

GET List companies

companies.read or companies.manage  

GET List of users associated with company

companies.read or companies.manage  

POST Create one or multiple companies

companies.manage  

PUT Update one or multiple companies

companies.manage Although the endpoint is a PUT it actually functions as a PATCH

DEL Delete companies by ID

companies.manage  

Users

The Users related API endpoints provide full CRUD (create, read, update, delete) functionality for user management to API consumers.

API Endpoint Permission Required Comments
GET List user fields users.read or users.manage Returns a list of all fields on the customizable User Shared Fields / User Profile

GET List users

users.read or users.manage  

POST Create one or multiple users

users.manage  

POST Add user to company

users.manage This endpoint is required after the POST Create one or multiple users endpoint, for each user created.

Each user created must be associated to a single primary company and this endpoint is used to associate a user to a company.

If a user is not associated to a primary company then portal functionality will be limited.

PUT Update one or multiple users

users.manage Although the endpoint is a PUT it actually functions as a PATCH

DEL Delete users by ID

users.manage Although the endpoint is a DEL it actually only deactivates the user(s)

DEL Delete one or multiple users from company

users.manage  

Actions

The Actions related API endpoints provide read functionality of Allbound-related actions to API consumers.

API Endpoint Permission Required Comments
GET List of actions actions.read or actions.manage  

 

List of Filterable Actions

Below is a list of all actions by which you can filter the GET List of actions api endpoint.

filters[action] Value Correlated Object
added_to_likes content
added_to_pins content
added_to_playbook content
co-branded content
commission_created commission
commission_rule_created commission
commission_rule_updated commission
commission_updated commission
completed_a_campaign content
completed_ext_training training
completed_form form
completed_learning_track content
completed_their_profile user
created_a_company company
created_colab colab
created_prospect_page prospect_page
deleted_a_lead lead
deleted_an_mdf mdf
deleted_playbook company
failed_quiz learning_track
had_a_campaign_approved content
logged_in user
logged_out user
passed_quiz learning_track
received_a_certificate certification
received_ext_certificate certification
registered_a_deal deal
registered_a_lead lead
registered_an_mdf mdf
removed_from_likes content
removed_from_pins content
removed_from_playbook content
requested_a_campaign content
shared_via_email content
shared_via_social_network content
updated_a_company company
updated_a_deal deal
updated_a_lead lead
updated_an_mdf mdf
user_registered user
viewed_content content
workflow_created workflow
workflow_updated workflow

Pipeline

Coming soon - Q1 2024!

API Support

If you have questions or run into an issue with our Open API, please submit a support ticket by emailing help@allbound.com.

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request