ClientID

What is a clientId?

A clientId is a unique GUID or Globally Unique Identifier assigned to each integration. This clientId is required for all API calls made by your integration. This will be used to monitor integration performance and systems' health.

Asked for a clientId?

You should never share your clientId, doing so may result in issues relating to integrations in your environments. A clientId is unique to your company and is used to say that API traffic comes from your source. It should be treated as a sort of password and identifier for your company. We may disable any clientId that looks to have been compromised if we suspect any abuse. If anyone asks you to provide a clientId value, do not do so. The only exception to this rule would be integrations where you yourself are creating it. If a tool requires that you enter the API full path, the body, and request, map it to different things, or otherwise is a custom tool that the vendor is not actually developing the calls, you may have to enter your clientId. Do not provide clientId values to integrations that are designed "out-of-the-box" and apply to all users.

Implementation

The clientId is implemented through an HTTP header in the API request. If you are working with a tool that lets you set your own headers, such as postman, you would simply add the header key of ClientID and a value of the unique GUID that is provided.

ClientID: 2FF4CEDF-EBDD-4770-A5C5-E876F59BBC19

Obtain ClientID

Please contact our customer service team to sign up for a clientid and developer key and begin using our API today.