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.

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

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

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

We release new feature in line with our versioning principles.

Please note that in order to get early feedback, the majority new features will be first announced as "preview" for early access customers

Visit our changelog for information on current and past versions

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