---
title: "Listing roles"
method: GET
path: "/roles"
tags: ["Job Roles"]
---

# Listing roles

`GET /roles`

Returns a list of job roles.

## Query parameters

- `id` number
- `name` string
- `code` string
- `fields` string
- `perPage` integer
- `page` integer

## Response `200`

An array of roles

- PaginatedRole — An array of roles
  - `results` Role[], required
    - `id` integer, required — Role ID
    - `name` string — Role name
    - `code` string — External code of the role
    - `similarTo` 'analyst' | 'apprentice' | 'auxiliary' | 'consultant' | 'coordinator' | 'developer' | 'director' | 'intern' | 'specialist' | 'supervisor' | 'manager' | 'operator' | 'technician' | 'trainee' — Role is similar to
    - `createdAt` string, date-time, required — Role creation date
    - `updatedAt` string, date-time, required — Role update date
  - `totalResults` integer
  - `page` integer
  - `totalPages` integer

## Other responses

- `400` — BadRequest / Invalid Input
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/gupy/apis/gupy-public-api.md) · [All operations](https://skmtc.net/gupy/apis/gupy-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gupy/gupy-public-api/versions/3f26defa2a42/schema)