Job Category Details

get
Job Category Details

https://apigateway.boost.rs/job-categories/:id
This endpoint retrieves job category details.
Request
Response
Request
Path Parameters
id
required
integer
The ID of the job category for which to retrieve details
Headers
Authorization
required
string
Authorisation token received from oAuth API Bearer :token
Response
200: OK
Job category successfully retrieved. NOTE: Repository information will only be provided for cases where the Job Repository feature is present.
{
"success": true,
"message": "",
"result": {
"id": 46,
"name": "Development",
"description": " ",
"external_id": null,
"status": "active",
"parent_id": null,
"has_subcategories": false,
"has_jobs": true,
"translations": {
"fr": {
"name": "IT",
"description": " "
},
"en": {
"name": "Development",
"description": null
}
},
"benchmark": {
"remote_index": 89,
"automation_index": 56
},
"repository": {
"id": 1,
"name": "Main repository",
"description": null,
"external_id": null,
"status": "active",
"has_categories": true,
"translations": {
"en": {
"name": "Main repository",
"description": null
},
"fr": {
"name": "Referentiel principal",
"description": null
}
}
}
}
}
404: Not Found
The provided job category was not found in the database
{
"message": "Resource not found",
"success": false,
"result": null
}

Response fields

Field name

Description

id

Category ID

name

Category title

description

Category description

external_id

Alphanumeric value (optional) which can be set by the client for external cross-referencing purposes.

status

Category status. Available values:

active - the category is ready for use (completed)

draft - the category content might not be the final (it might not be ready for use)

parent_id

The ID of the parent category

has_subcategories

Boolean value.

true - the category contains sub-categories

false - the category does not contain sub-categories

has_jobs

Boolean value.

true - the category contains jobs

false - the category does not contain any jobs

translations

Group of fields containing the available translations (per language) for the category title and description, if available.

Translation fields: en, fr - language codes name - category title description - category description

benchmark

Benchmark fields:

remote_index - the category's remote work index (values range: 0 to 100)

automation_index - the category's automation index (value range: 0 to 100)

repository

The section provides the fields related to the parent repository.

Repository fields:

id

name

description

external_id

status

has_categories

For more information see Job Repository Details.