Skip to content

Retrieve A Specific Job

Request

Retrieves the job from vWork that has the given id.

Security
apiKey
Path
idstringrequired
Query
api_keystringrequired
use_third_party_idboolean

When set to true (e.g. 'true') the :id argument is taken to be the job's third party id instead of the job's normal id.

Example:use_third_party_id=true
with_deletedboolean

When set to true the response will also include jobs that have been deleted.

Example:with_deleted=true
Headers
Accept-Encodingstringrequired

Must be gzip. The vWork API requires HTTP compression on all requests; requests without it may be rejected with 406 Not Acceptable (see Tech Notes → HTTP Compression).

Value:"gzip"
Example:gzip
GET
/v5/jobs/{id}.xml
curl -i -X GET \
  'https://api.vworkapp.com/api/v5/jobs/{id}.xml?api_key=string&use_third_party_id=true&with_deleted=true&api_key=YOUR_API_KEY_HERE' \
  -H 'Accept-Encoding: gzip'

Responses

OK

Headers
Transfer-Encodingstring
Example:"Chunked"
Statusstring
Example:"200 OK"
Cache-Controlstring
Example:"max-age=0, private, must-revalidate"
Content-Encodingstring
Example:"gzip"
Bodyapplication/xml; charset=utf-8
string

Raw XML payload — see the example.

Response
<?xml version="1.0" encoding="utf-8"?>
<jobs type="array" current_page="1" per_page="1" total_pages="1" total_entries="1">
    <job>
        <id readonly="readonly">7996018</id>
        <job_type readonly="readonly">job</job_type>
        <group_ids/>
        <status>unassigned</status>
        <third_party_id>ABC123</third_party_id>
        <customer_name>JoeSmith</customer_name>
        <template_name>Template</template_name>
        <customer_id>822326</customer_id>
        <worker_id/>
        <worker_third_party_id/>
        <worker_name/>
        <worker_duration>0</worker_duration>
        <published_at type="datetime"/>
        <has_pod readonly="readonly">false</has_pod>
        <signed_at readonly="readonly"/>
        <signed_by readonly="readonly"/>
        <paused_at/>
        <planned_duration>7200</planned_duration>
        <planned_start_at type="datetime"/>
        <planned_end_at type="datetime" readonly="readonly"/>
        <actual_start_at type="datetime" readonly="r…