How Can I Download All my Data?

A common use of the vWork API is to retrieve completed job data for data warehousing or just to keep an archival copy as vWork only stores live data for one year by default.

Whilst this can be done using the CSV Export report, (instructions available here) many customers prefer to automate this task using the API. There are a number of ways of retrieving job data via the API.

You can get one job at a time if you know the Job ID. 

  • The following example retrieves job 123456, using an API Key of ABCDEFG:  
  • https://api.vworkapp.com/v4/jobs/123456.xml?api_key=ABCDEFG
  • Full documentation is here.

Or you can ask the API for all completed jobs since the last time you asked using the completed_at filter.

  • The following example retrieves all completed jobs since the 1st of January 2018 at 9am NZDT time: 
  • https://api.vworkapp.com/v4/jobs.xml?api_key=ABCDEFG&status=completed&completed_at=2018-01-01T09%3A00%3A00%2B13 
  • Full documentation is here.

The final option is to ask the API for jobs that were completed between a start time and an end time.

  • The following example retrieves all completed jobs between the 1st of January 2018 at 9am NZDT time and the 31st of March 2018 at 5pm NZDT time: 
  • https://api.vworkapp.com/v4/jobs.xml?api_key=ABCDEFG&status=completed&start_at=2018-1-1T09%3A00%3A00%2B13&end_at=2018-3-31T17%3A00%3A00%2B13
  • Full documentation is here.

Depending on how many results you get from your query, you may need to retrieve multiple pages of results.  There is more information on API paging available here.

If you need a hand with any of this or simply need an API key, please send an email to support@vworkapp.com, we're always happy to help.



Need more information? ask us hereHave more questions? Submit a request