> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mileapp.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Role

> This API enables you to retrieve a list of predefined roles and any custom roles associated with you...

## What is Role?

This API enables you to retrieve a list of predefined roles and any custom roles associated with your account. By making a GET request to this API, you can obtain information about the available roles within the system. The predefined roles refer to a set of role types that are already defined by the system. In this particular case, the predefined roles include Finance, Owner, Planner, Admin, and Field User. Additionally, the API may also return any custom roles that have been created within your account.

**To see the details of role object, please follow [this link](/api-reference/objects/role-object)**

## Key Features

<CardGroup cols={2}>
  <Card title="Read role" icon="list" href="/api-reference/setting/role/read-role">
    GET /roles
  </Card>

  <Card title="Read role by ID" icon="list" href="/api-reference/setting/role/read-role-by-id">
    GET /role/{roleId}
  </Card>
</CardGroup>

## Related Resources

* [Role Object](/api-reference/objects/role-object) - Role data structure