Retrieve a sector
Returns a single sector record by its internal ID.
Tip
Check the Swagger page for more technical information on the endpoints.
Endpoint details
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/sectors/{sectorReference}
Headers: Authorization: Bearer {token}, User-Agent: {agent}
Scope: connector-protimeapi-sectors.read
URL parameters
| Parameter | Description |
|---|---|
<sectorReference> |
The internal ID or external reference of the sector. |
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 sector. |
name.default |
string | — | Read-only | Default name of the sector. |
name.translations |
object | — | Read-only | Translated names for supported languages. |
External references
The endpoint supports custom external references. See the external references page for details.
Error responses
| Status | Condition |
|---|---|
400 |
Invalid external reference specification |
401 |
Missing or invalid access token, or insufficient scope |
404 |
Sector not found for the given ID or external reference |
Examples
Retrieve one sector
Example retrieving one sector with internal ID 456:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/sectors/456
Retrieve a sector with a custom external reference
Example retrieving a sector with a custom external code FD789:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/sectors/FD789?externalReferences=(sectors,CustomReferenceName)