Retrieve a work location

Returns a single work location by its internal ID or external reference.

Endpoint details

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-locations/{workLocationReference}

Headers: Authorization: Bearer {token}, User-Agent: {agent} Scope: connector-protimeapi-work-locations.read

URL parameters

Parameter	Description
{workLocationReference}	The internal ID or external reference of the work location.

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 work location.
name.default	string	—	Read-only	Default name of the work location.
name.translations	object	—	Read-only	Translated names for supported languages.
description	string	—	Read-only	Description of the work location.

External references

The endpoint supports custom external references for the work-locations collection. Predefined references are not available.

See the external references page for details.

Collection	Predefined	Custom
work-locations	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	Work location with the given ID or external reference not found

Examples

Retrieve one work location

Example retrieving one work location with internal ID 456:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-locations/456

Retrieve a work location with a custom external reference

Example retrieving a work location with a custom external code 789:

https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/work-locations/789?externalReferences=(work-locations,CustomReferenceName)