v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

JobCatalog > Role

Reads a single Role

get/api/2026-07-01/resources/job_catalog/roles/{id}

Path parameters

idstring required

Response

idstring required

identifier for the job catalog role.

company_idstring required

Identifier for the company.

namestring required

Role name.

descriptionstring

Role description.

legal_entities_idsstring[] required

List of legal entities.

supervisors_idsstring[]

List of supervisors.

competencies_idsstring[]

List of competencies.

archivedboolean required

Shows if the role is archived.

Example response

{
  "id": "1",
  "company_id": "1",
  "name": "CFO",
  "description": "Financial director of the company.",
  "legal_entities_ids": [
    "1",
    "2"
  ],
  "supervisors_ids": [
    "1",
    "2"
  ],
  "competencies_ids": [
    "1",
    "2"
  ],
  "archived": true
}