> For the complete documentation index, see [llms.txt](https://docs.plextrac.com/plextrac-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.plextrac.com/plextrac-documentation/api-documentation/retrieving-parameter-ids.md).

# Retrieving Parameter IDs

Parameters are essential components that can be included with an endpoint to modify the behavior and response obtained from the PlexTrac API. These parameters serve as options, allowing users to customize their requests, retrieve specific information, or perform specific actions.&#x20;

The following is a compilation of commonly used parameters in various PlexTrac API endpoints, accompanied by an explanation of locating the corresponding values within the platform to fulfill each request's specific requirements.

## Tenant IDs

The `tenantId` is returned when an authentication API is requested, as shown here:&#x20;

<div align="left"><figure><img src="/files/hLS6jVlhxqMCJcGdh0Gp" alt=""><figcaption></figcaption></figure></div>

## Client IDs

The `clientId` can be retrieved from the platform by going to the **Clients** module, clicking the desired client, and looking at the numerical value in the URL between "clients" and "reports" in the URL path.

<div align="left"><figure><img src="/files/FzruMhcQaF4LVtiEC2NZ" alt=""><figcaption></figcaption></figure></div>

## Finding IDs

The `findingId` can be retrieved from the platform by going to a client or report, clicking the **Findings** tab, clicking the desired finding, and looking at the **Finding ID** field.

<div align="left"><figure><img src="/files/RjGlzZnk0BlUI4ixpXri" alt=""><figcaption></figcaption></figure></div>

## Report IDs

The `reportId` can be retrieved from the platform by going to the **Reports** module, clicking the desired report, and looking at the numerical value at the end of the URL.

<div align="left"><figure><img src="/files/84Wr4q0PJ0ofv5mKLiZT" alt=""><figcaption></figcaption></figure></div>

## Repository IDs

The `repositoryId` for DBs can be retrieved from the platform by going to the desired module under the **Content Library**, clicking the appropriate repository card, and looking at the value at the end of the URL.

<div align="left"><figure><img src="/files/Vo7AQSLJ1JepaLYorXtA" alt=""><figcaption></figcaption></figure></div>

## Role IDs

The `roleId` for default roles are:

* **ADMIN:** cljhc9ggj000008l99gkyai90
* **STD\_USER:** cljhc9rvn000208l9g4lpai54
* **ANALYST:** cljhc9yh1000308l9ar7j8mux

The `roleId` for custom roles can be identified by looking at the URL of the role within the platform.&#x20;

<mark style="background-color:yellow;">Step 1:</mark> Click **Account Admin** under the user name pulldown menu.

<div align="left"><figure><img src="/files/nj6G8yK8SVO4UCCKm5ms" alt="" width="272"><figcaption></figcaption></figure></div>

<mark style="background-color:yellow;">Step 2:</mark> Click **Security** under "Security & User Management."

<div align="left"><figure><img src="/files/FE2eLbu3AvMNXUYYtQb0" alt="" width="249"><figcaption></figcaption></figure></div>

<mark style="background-color:yellow;">Step 3:</mark> Click **Role Based Access**.

<div align="left"><figure><img src="/files/FO0uIBXlifAjPEXzGEsd" alt="" width="232"><figcaption></figcaption></figure></div>

<mark style="background-color:yellow;">Step 4:</mark> Click the box of the custom role.

<div align="left"><figure><img src="/files/W1ugGC1m0wmPntqYxvuF" alt=""><figcaption></figcaption></figure></div>

The `roleId` is the value at the end of the URL.

<div align="left"><figure><img src="/files/dhFOZxz3QnDUySc6efjn" alt=""><figcaption></figcaption></figure></div>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.plextrac.com/plextrac-documentation/api-documentation/retrieving-parameter-ids.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
