---
title: "List JIE Roles"
method: GET
path: "/api/v2/JIE/roles"
tags: ["JIE"]
---

# List JIE Roles

`GET /api/v2/JIE/roles`

This endpoint returns a list of roles. If a new role is created, it takes some time to show up in the list call, you can fetch that role using get endpoints right after the creation of role

## Query parameters

- `start` integer
- `limit` integer
- `filterQuery` string
- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `data` ExternalJIERoleSchema[]
    - `externalId` string, nullable — external role id for a role
    - `id` string, nullable — id of the role
    - `skillProficiencies` SkillProficiency[], nullable — skill proficiencies of the role
      - `proficiency` number, float, nullable — proficiency of the role
      - `skillGroupList` SkillGroupList[], nullable — skill group list of a role
        - `proficiency` number, float, nullable — group proficiency of the skill group
        - `groupName` string, nullable — name of the skill group
        - `level` string, nullable — level of the role
        - `skillCategory` string, nullable — skill category of the skill group
      - `level` string, nullable — level of the role
      - `name` string, nullable — name of the role
    - `experience` PreferredExperience
      - `preferredYearsOfExperience` PreferredYearsOfExperience
        - `typeOfExperience` string, nullable — Type of experience, can only be one of 'total', 'relevant'
        - `maxExperience` integer, nullable — preferred maximum experience titles for a role
        - `minExperience` integer, nullable — preferred minimum experience titles for a role
      - `companies` Preference[], nullable — preferred companies for a role
        - `preferenceType` string, nullable — preference Type for value, can only be one of ['Preferred', 'Required', 'Excluded']
        - `value` string, nullable — Value/Name of the attribute
      - `seniorities` string[], nullable — preferred seniorities for a role. Values for seniorities can only be one of 'display' values of seniority_levels in calibration config in admin console.
      - `jobTitles` Preference[], nullable — preferred job titles for a role
        - `preferenceType` string, nullable — preference Type for value, can only be one of ['Preferred', 'Required', 'Excluded']
        - `value` string, nullable — Value/Name of the attribute
    - `idealCandidateUrls` string[], nullable — LinkedIN URL's of preferred/ideal candidates for the role
    - `education` PreferredEducation
      - `graduationYear` GraduationYear
        - `graduationEndYear` integer, nullable — end year of graduation
        - `graduationStartYear` integer, nullable — Start year of graduation
      - `schools` Preference[], nullable — preferred schools for a role
        - `preferenceType` string, nullable — preference Type for value, can only be one of ['Preferred', 'Required', 'Excluded']
        - `value` string, nullable — Value/Name of the attribute
      - `degreeMajors` string[], nullable — degree majors for a role. Values for degree majors can only be the external_id of the degree major.
      - `certifications` string[], nullable — certifications for a role. Values for certifications can only be the external_id of the certification.
      - `degrees` string[], nullable — preferred degrees for a role. Values for degrees can only be one of 'display' values of education_levels in calibration config in admin console.
    - `calibrationNotes` string, nullable — calibration Notes for a role
    - `roleDescription` string, nullable — description of the role
    - `rmUserGroups` RmUserGroup[], nullable — RM user groups associated with the role.
      - `userGroupId` string, nullable — Unique identifier for the user group
    - `idealCandidates` string[], nullable — EF profile ids of preferred/ideal candidates for the role
    - `associatedTags` RoleTagSchema[], nullable — associated tags with the role, these tags are specific to a role and are generally filled in with a unique tag value. Only pre-configured tags in role_library_config:integration_config:configuration_tags are allowed
      - `tagValues` string[], nullable — value of the tag
      - `tagName` string, nullable — name of the tag
    - `approvalStatus` string, nullable — approval status of role, can be one of ['approved', 'unapproved']
    - `locations` string[], nullable — preferred locations for the role
    - `archivalStatus` boolean, nullable — is archival of role
    - `title` string, required — title of the role
    - `displayTags` RoleTagSchema[], nullable — display tags of the role. They may or may not be unique to a role. Only pre-configured tags in role_library_config:integration_config:display_tags are allowed
      - `tagValues` string[], nullable — value of the tag
      - `tagName` string, nullable — name of the tag
  - `meta` MetaSchema
    - `totalCount` integer, nullable
    - `pageTotalCount` integer, nullable
    - `pageStartIndex` integer, nullable

---

[API](https://skmtc.net/eightfold/apis/api-server-v2-service-service.md) · [All operations](https://skmtc.net/eightfold/apis/api-server-v2-service-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eightfold/api-server-v2-service-service/versions/0fb26f4e41bf/schema)