Getting Started

Access Tokens

We use Microsoft's OAuth endpoint with the client credentials flow.  Check out Microsoft's documentation for client credentials flow here.

Once you have API credentials from our staff, you can create an access token. 

The credentials include the following bits of information:

• client id (sometimes called application id)

• client secret (sometimes called password)

• tenant

• scope

On a successful response of the token request, use the access_tokenvalue in the Authorization header to our endpoints.

Authorization: Bearer eyJ0eXxxx.... (truncated for brevity)

Note that the in-browser widget for executing calls  ("Try it" feature) has a field for Subscription Key.  We don't use this so please leave it blank. 

API Definition File

A definition file can be downloaded that can be used to create a client. In the API Details page, click the API Definition dropdown and select the desired format.