Retrieving Parameter IDs
Parameters are options passed with the endpoint to influence the response. This page lists common PlexTrac API parameters used in its endpoints with explanations on how to find values within the platform for needed requests.

Tenant IDs

The tenantId is returned when an authentication API is requested, as shown here:
The tenantId can also be found within the platform by looking at any user profile inside that tenant.
Step 1: As an admin, go to the Admin Dashboard by clicking Account Admin.
Step 2: Click Users under "Security & User Management."
Step 3: Look at the Tenant ID value.

Client IDs

The clientId can be retrieved in the platform by going to the Clients module, clicking the desired client, and looking at the url.

Finding IDs

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

Report IDs

The reportId can be retrieved in the platform by going to the Reports module, clicking the desired report, and looking at the url.

Repository IDs

Both NarrativesDB and WriteupsDB repositoryId can be retreived by going to the desired module under Content Library, clicking the appropriate repository card, and looking at the url.

User IDs

The userId can be retrieved by an admin by looking up the user's profile.
Step 1: As an admin, log in to PlexTrac and go to the Admin Dashboard by clicking Account Admin.
Step 2: Click Users under "Security & User Management."
Step 3: Retrieve the desired User ID value.
Click Next below to for a list of common endpoints.
Copy link
On this page
Tenant IDs
Client IDs
Finding IDs
Report IDs
Repository IDs
User IDs