Skip to main content

Orgvue API at a glance

The Orgvue API allows automated access to the data you have stored in your Orgvue tenant enabling full integration with your HR Information System.

Key details​

  • Access to the Orgvue API is granted per tenant on request. To request access please email our support team at support@orgvue.com quoting your tenant ID
  • We provide a simple integration using either asynchronous or synchronous responses. See Synchronous or Asynchronous Invocation to decide which is best for your application
  • We support a number of export formats and recommend JSON for most requests
  • Authentication to our API is via Token credentials, see Authentication for details
  • Many of our API endpoints provide you with ways to interact with Orgvue in an asynchronous manner through secure temporary files. These belong to your Tenant, are securely encrypted at rest, and will be automatically deleted after a set period of time

API Reference Documentation​

Our API reference documentation is an overview of which endpoints are available

It details the required Request Body Schema for each call along with any available Query Parameters and examples of data included in responses

Click Here to access the API reference documentation

API Recipes​

Our API recipes section details the prerequisites and method required to perform common tasks when using the Orgvue API with your HRIS

API Security​

The Orgvue API is restricted to users with valid accounts for your Orgvue tenant.

Each API user must have token access enabled for their account as well as a valid token created for the IP address making the API call

Secure Temporary Files are created via an API request and data within them is encrypted and cannot be accessed without the use of the presigned secret URL which has been created via bearer tokens

Data held in these temporary files will be removed automatically with the secret URL expiring 15 minutes after creation

For full details of Orgvues security and compliance standards visit the Orgvue Trust Centre

Help and Support​

For links to user guides for other Orgvue resources visit the Orgvue User Documentation page

If you wish to give us feedback on the API please use the Feedback link

For further assistance please email our support team at support@orgvue.com