Retrieve a job category
Introduction
You can retrieve a job category 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/job-categories/{jobCategoryReference}
URL parameters
This parameter needs to be filled in when calling this endpoint.
| Parameter | Description |
|---|---|
<jobCategoryReference> |
The internal ID or external reference of the job category. |
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 category. |
name.default |
string | Default name of the job category. |
name.translations |
object | Translated names for supported languages. |
externalCode |
string | External code for the job category. |
External references
It’s possible to use custom external references as a jobCategoryReference to retrieve a job category. 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 a job category
Example retrieving a job category with internal ID 456:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/job-categories/456
Retrieve a job category with a custom external reference
Example retrieving a job category with a custom external code 1795:
GET
https://<tenant>.myprotime.eu/connector/protimeapi/api/v1/job-categories/1795?externalReferences=(job-categories,CustomReferenceName)