Skip to content

Jobs and Tags

Tags are a subset of vWork's Health and Safety module and are generally not enabled by default.

Tags need to be defined in your account before they can be added to your jobs. This can be done via the website or via the Tags API route. This section of the documentation assumes some tags already exist for your account.

Once created, you can add specific tags to your workers, jobs and templates. This will prevent your dispatchers from assigning jobs to workers that do not have the required qualifications for a certain job.

If you need to include a tag on the job, you can PUT or POST an array of tag IDs in the job XML.

The following example adds tag 123 and tag 456 to the job.

<taggings type="array">
  <tagging>
  <tag_id>123</tag_id>
  </tagging>
    <tagging>
  <tag_id>456</tag_id>
  </tagging>
</taggings>

To remove tag 17 from job 1234567, you would send a DELETE command to the following URL. (In this situation, you reference the tag ID from the job, not the tag ID from the account.)

https://api.vworkapp.com/api/v4/jobs/1234567/taggings/17.xml?api_key=123

You can retrieve a list of tags for your account via the API using the tags route.