---
title: "Search Roles"
method: GET
path: "/api/v1/roles/_search"
---

# Search Roles

`GET /api/v1/roles/_search`

## Query parameters

- `searchName` string
- `searchKey` string
- `roleId` string
- `start` integer
- `count` integer
- `includeUserRoles` boolean
- `includeWorkflowRoles` boolean

## Response `200`

- ResponseEntitySmallRoleView
  - `errors` ErrorEntity[]
    - `errorCode` string
    - `message` string
    - `fieldName` string
  - `entity` SmallRoleView[]
    - `name` string
    - `id` string
    - `roleKey` string
    - `user` boolean
  - `messages` MessageEntity[]
    - `message` string
  - `i18nMessagesMap` object
  - `permissions` string[]
  - `pagination` Pagination
    - `currentPage` integer
    - `perPage` integer
    - `totalEntries` integer

---

[API](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api.md) · [All operations](https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/anzworldline-solutions/dotcms-rest-api/revisions/0f38cbc3bd36/schema)