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

# List Roles

`GET /api/v2/Roles`

## Request

- Base URL: `https://secure.agco-ats.com`
- URL: `https://secure.agco-ats.com/api/v2/Roles`
- Auth: none declared

No Documentation Found.

## Query parameters

- `limit` integer
- `offset` integer
- `name` string
- `permissionID` integer
- `permissionName` string

## Response `200`

OK

- APIPagedResponseAPIModelsRole: A response containing a page of results and metadata concerning the results
  - `Metadata` APIPagedResponseMetadata, required: Metadata for the paged response
    - `TotalCount` integer, required: The total number of entities matching the request.
    - `Limit` integer, required: The number of entities this paged response is limited to.
    - `Offset` integer, required: The number of entities prior to this page of items.
  - `Entities` APIModelsRole[], required: The set of entities that make up this page.
    - `Id` integer: The role's identifier.
    - `Name` string, required: The name of the role. Must be alpha-numeric strings separated by a period (.).
    - `Description` string, required: Role description

## Changes

- **2026-02-08** `375dfaeb5a29`: 2 info
  - added the new optional `query` request parameter `permissionID`
  - added the new optional `query` request parameter `permissionName`

[Operation history](https://skmtc.dev/agco-ats/apis/agco-ats-api/changes/api/v2/Roles/get.md)

---

[API](https://skmtc.dev/agco-ats/apis/agco-ats-api.md) - [All operations](https://skmtc.dev/agco-ats/apis/agco-ats-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agco-ats/apis/agco-ats-api/revisions/8b416443df5c?raw)