Skip to main content

Edge API References

Jorge Ferreira Filho
  • Updated

Who can use this feature?

Available on All Products
Available to Only Admins
Billing Center Get a Demo

Calling all automation enthusiasts! 

Some tasks take a lot of time away from your busy day. We rely on automation to help ease this time sink by doing otherwise manual tasks automatically, based upon some trigger.

Table of Contents

What is Edge API? Which Endpoints are Available?

Our Edge API, named this way due to the subdomain used to access it, is a series of endpoints an admin can use to create either one-off requests or automated actions.

Using JSON or basic ID numbers, you can perform various actions on several assets. These endpoints are broken down into the ones below. You can also refer to our API References documentation for further details. You can find the full list of endpoints here.

Health

  • Monitor the health of your application

Tenant

  • Your organization's tenant id

Rule

  • Create/Update/Delete and List of Rules for tenant

Workspace

  • Read all workspaces
  • Remove users from a workspace
  • Remove users from all workspaces
  • Add users to a workspace
  • Read all users (or in a workspace)

Team

  • Remove users from a team
  • Remove users from all teams (within workspaces or from all workspaces)
  • Add users to a team
  • Read all teams

Distribution

  • Update distribution and publish it
  • Delete distribution
  • List all distributions

Availability

  • Gets available slots of assignees in round-robin meetings

User

  • Updates licenses for users
  • Invites new users to the organization
  • Read user information
  • Find user

CRM

  • Activity via CRM event Id
  • Cancel a CRM event via CRM event Id
  • No show at a CRM meeting via CRM event Id

Meetings

  • Activity
  • Cancel a meeting
  • No show a meeting
  • Query list of meetings
  • Get a meeting by id
  • Export meetings into CSV

Concierge

  • Read Concierge logs
  • List Concierge routers

Scheduling Links

  • List user's personal scheduling links
  • List round robin scheduling linksd

Generating and Managing Your Tokens

If you plan on automating, you must have session tokens generated to ensure you have access to them.

Generate a new Token:

  1. In the Admin Center, navigate to Integrations:


  2. Then, access the API Access Tokens tab:
  3. There, you can use the Generate Token button to create a new one. 

  4. A pop-up will prompt you to select a name for your Token. Once ready, click Next.


  5. Next, it's time to select which permissions this Token will have (Ping, Modify, Read, Remove) and under which sections. For example, if you need a Token only for Team management, you can give the required permissions only under the Team section.
    Once ready, click Generate
  6. The Token will be generated. Ensure to copy and save it, as you won't be able to copy it later!


Managing and Deleting Tokens

Within the same page, you will see a list of generated Tokens for your org alongside useful data such as Last Access, Created Date, and Created By.

You can also click the three dots (...) to view the Token's permissions and Remove and Delete.

Note that once you delete a Token, it will also revoke view, update, and manage access to your organization’s data for that Token.

How to Execute/Test an Endpoint

You can run the endpoint directly via cURL request or with an app such as Postman. Each endpoint is appended by https://fire.chilipiper.com. You can also utilize these requests in automation apps such as Zapier (as webhooks).

Use the API references to determine the schema/formatting of each request

 

Swagger UI

You can also use this Swagger UI, where you can test and execute the APIs:

  1. Expand the section you want to test
  2. Click Try it out


  3. Add the required parameters in the request's body. More details on finding your assets ID can be found in this section below.


  4. Click Execute, and you will have the execution response displayed.

 

Finding your Assets IDs

You will notice in the API References page that, within some Payloads, an Id will be required for testing or executing APIs. For example, the one below requires a workspaceId and userIds:

Let's see below how they can be found per section. 

 

Workspace

In the Admin Center's Workspace page, click Open next to the one you want to collect the ID. Once it opens, the ID can be found in the browser URL:


Team 

Navigate to the workspace you wish, expand Assets in the left-hand menu, and then Teams. Click Open next to any Team you want, and you will find the ID here:


Distribution

Navigate to the workspace you wish, expand Assets in the left-hand menu, and then Distributions. Click Open next to any Distribution you want, and you will find the ID here:


Users

In the Admin Center's Users Table page, click Open next to an active user. The ID goes here:

 

CRM

The crmEventId will be mostly grabbed from your CRM instance's Events.

 

Meetings

Navigate to the workspace you wish, expand Reports in the left-hand menu, and then Meeting Activity. Click Open next to any meeting you want, and you will find the ID here:

Example Request in Postman

We can also see how this might be set up in Postman to execute a one-off request.

Response Code Statuses

200 - Request successful
404 - ID was not found, or URL cannot be accessed
400 - Bad request. Check the syntax of the request so that it matches our schema

401 / 500 - These usually indicate the user does not have permission to execute the request

Notes

  • When executing a query to retrieve a large number of records, the maximum number of records that can be returned in the response is 100.

    • The default response will return 50 records if no value is provided by the caller

    • Any caller can cycle through however many pages they want, each with up to 100 records.

    • A query string parameter ?pageSize=100 can be appended to the endpoints' response to allow for a request of up to 100 values.

    • We supply a 'nextPage' endpoint value at the end of the request to paginate through the response payload if you need to query more than 100 records.

 

Related articles