Who can use this feature?
👤 Organizations Owners and Admins.
🚩 Available on the Essential and Enterprise Plans.
Overview
The ArborXR Public API V2 provides access to your organization’s data via a RESTful interface.
The root of v2 of the API is located at https://api.xrdm.app/api/v2
. From the documentation page, you can download the OpenAPI spec documentation as JSON or YAML, for use with your API development client of choice.
Generate an Access Token
When generating an access token, you’ll have the option to choose the scopes you want to grant. Different scopes will allow you to access different resources in the API.
Navigate to organization Settings, select Access Token in the top right, then click Create Access Token.
Enter a title, check the Public API checkbox, then click Create.
Copy the token value before closing.
Authentication
Once you’ve generated an access token, you can use that token to make HTTP requests to the API, by adding it as a bearer token to your request’s Authorization
header. You should also be sure to include the Accept
and specify that you expect a JSON response.
Authorization: Bearer <access_token>
Accept: application/json