---
title: "Get Role"
method: GET
path: "/roles/{ID}"
tags: ["Roles"]
---

# Get Role

`GET /roles/{ID}`

## Request

- Base URL: `https://api.forcemanager.com/api/v4`
- URL: `https://api.forcemanager.com/api/v4/roles/{ID}`
- Auth: API key in header `X-Session-Key`

This endpoint retrieves data of a specific Role based on JSON input. The API returns a single Role available to the user, according to the unique ID provided. If the specified Role does not exist, the response will be a "bad request".

You will only receive the Role's information after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).

**HEADERS**

| **Parameter** | **Value** | **Description** |
| --- | --- | --- |
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | \*/\* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |

**REQUEST**

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| id | integer | The unique and specific identifier of the Role |

**RESPONSE BODY**

| **Attribute** | **Type** | **Description** |
| --- | --- | --- |
| branches | Object | List of the Role Branches |
| extId | Integer | External ID of the Role from a third party system (ERP, CRM, Accounting System) |
| id | Integer | The unique identifier of the Role in ForceManager |
| level | Integer | Between 1-5. The priority of this role, being 1 minor and 5 major |
| name | String | The name of the role |
| dateCreated | String | Date and time when the Role was created |
| dateDeleted | String | Date and time when the Role was deleted |
| dateUpdated | String | Date and time when the Role was last updated |
| deleted | Boolean | If true, the Role has been deleted and archived |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Role |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Role |
| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Role |

**RESPONSE CODES**

| **Status** | **Description** |
| --- | --- |
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |

## Headers

- `Accept` string
- `X-FM-Entity-Count` string

## Response `200`

Get Role

---

[API](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer.md) · [All operations](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/llms.txt) · [OpenAPI document](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/revisions/87db17204e2f?raw)