OpenAPI Definitions

Download the OpenAPI definition for any PerspioTalk API, or import it straight into Postman.

Each PerspioTalk API has an OpenAPI 3 definition. They're the same definitions this reference is built from, so they're always current, and each one includes both the AU and US servers.

APIOpenAPI definition
AppsDownload
AssetsDownload
ConnectorsDownload
DashboardsDownload
DevicesDownload
GeofencesDownload
GroupsDownload
OrganisationDownload
PeopleDownload
ProfilesDownload
PublicDownload
ReportsDownload
SearchDownload
ServicingDownload
TasksDownload
UsersDownload
WorkflowsDownload

Import into Postman

  1. In Postman, select Import.
  2. Paste the definition's link. Right-click Download in the table above and copy the link address.
  3. Import it as a Postman collection.

Postman creates a request for every endpoint in that API. Before sending requests, add your access token, tenant ID and subscription key. Get Access Token shows where each one comes from. Insomnia, Bruno and most other API clients import the same URLs.

Generate a client

Perspio doesn't publish SDKs. The Try It panel on each endpoint page generates request code in cURL, Node.js, Python, C# and more. If you'd rather have a typed client, you can feed these definitions to a code generator such as OpenAPI Generator. Perspio doesn't test generated clients, so check yours against the endpoints you use.