Retrieve a job
Introduction
You can retrieve a job by the internal ID or an external reference using the GET call.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/jobs/{jobReference}
URL parameters
This parameter needs to be filled in when calling this endpoint.
| Parameter | Description |
|---|---|
<jobReference> |
The internal ID or external reference of the job. |
Response properties
This list of properties is returned by this endpoint.
| Property | Type | Description |
|---|---|---|
changeVersion |
string | Property to indicate the order of changes. |
id |
integer | Unique identifier for the job. |
name.default |
string | Default name of the job. |
name.translations |
object | Translated names for supported languages. |
External references
It’s possible to use custom external references as a jobReference to retrieve a job. More information can be found on the External References Page
Note
Check the query options below the endpoint on the Swagger page for the relevant external references.
Examples
Retrieve one job
Example retrieving one job with internal ID 456:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/jobs/456
Retrieve a job with a custom external reference
Example retrieving a job with a custom external code 789:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/jobs/789?externalReferences=(jobs,CustomReferenceName)