Retrieve a job
Returns a single job by its internal ID or external reference.
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}
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-jobs.read
URL parameters
| Parameter | Description |
|---|---|
{jobReference} |
The internal ID or external reference of the job. |
Response properties
| Field | Type | Required | Writable | Description |
|---|---|---|---|---|
changeVersion |
string | — | Read-only | Property to indicate the order of changes. |
id |
integer | — | Read-only | Unique identifier for the job. |
name.default |
string | — | Read-only | Default name of the job. |
name.translations |
object | — | Read-only | Translated names for supported languages. |
External references
The endpoint supports custom external references for the jobs collection. Predefined references are not available.
See the external references page for details.
| Collection | Predefined | Custom |
|---|---|---|
jobs |
Not available | Supported |
Error responses
| Status | Condition |
|---|---|
400 |
Invalid external reference specification (e.g., unsupported predefined reference or non-integer ID without external reference) |
401 |
Missing or invalid access token, or insufficient scope |
404 |
Job with the given ID or external reference not found |
Examples
Retrieve one job
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/jobs/456
Retrieve a job with a custom external reference
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/jobs/789?externalReferences=(jobs,CustomReferenceName)