Phin Security icon

Phin Security

The Phin Security API allows partners to access their data programmatically. It provides endpoints for managing companies, retrieving historical phishing and training data, accessing reporting artifacts, and viewing usage information. The API must be enabled through the Phin Portal. Authentication uses OAuth2 Client Credentials flow via Auth0.

Actions10

Reports → Get list of reporting artifacts for a company

AI-generated

Summary

Retrieves reporting artifacts for a specific company.

Inputs

  • partnerId (required) — Your Phin Partner ID
  • companyId (required) — The Company ID
  • returnAll — Whether to return all results or only a single page. When disabled, no pagination parameters are sent and only one page of results is returned. Default: false
  • customBody — Optional. Send arbitrary JSON in the request body. Deep-merged with fields above; custom body values take priority. For GET requests, the body is not transmitted as the HTTP client does not send request bodies for GET methods. Default: {}
  • headerFilters — Add custom HTTP headers to the request.
  • queryFilters — Add query-string filters. Set the parameter name and value for each filter.
  • debug — When enabled, includes the actual URL, query parameters, headers, and body sent for each API request in the output under a debug entry. Useful for troubleshooting. Default: false
  • timeout — Time in milliseconds to wait for the server to send response headers before aborting the request. Default is 300000 (5 minutes). Default: 300000

Output shape

Array of reporting artifact metadata objects. Each item includes file metadata and a reportLink. If debug is enabled and API requests were made, a __debugLog entry is prepended to the output array.

When returnAll is true, offset-based pagination is applied via configurable settings (pageParam, startValue, increment, pageSize, sizeParam, maxPages, requestInterval). When false, a single GET request retrieves one page of results.

Examples

Example 1: Get a single page of reporting artifacts for company XYZ

partnerId: 'partner123', companyId: 'company456', returnAll: false

Example 2: Retrieve all reporting artifacts across all pages

partnerId: 'partner123', companyId: 'company456', returnAll: true, pagination: { paginationMode: 'offset', pageSize: 50, maxPages: 0 }

Links

Discussion