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

Usage → Get usage for a partner

AI-generated

Summary

Retrieves billing usage information for a Phin Security partner.

Inputs

  • partnerId (required) — Your Phin Partner 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.
  • 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.
  • timeout — Time in milliseconds to wait for the server to send response headers before aborting the request. Default is 300000 (5 minutes).
  • customBody — Optional. Send arbitrary JSON in the request body. This will be deep-merged with any fields above (custom body values take priority). Leave as {} to skip.
  • headerFilters — Add custom HTTP headers to the request.
  • queryFilters — Add query-string filters. Set the parameter name and value for each filter.
  • batching — Configure batching of input items. Items are grouped in batches of batchSize, with batchInterval milliseconds waited between batches.
  • pagination — Configure how pagination is handled for list operations.

Output shape

array

When returnAll is false, a single GET request is made and the response is returned as a single-element array. When true, paginated requests are made according to the pagination configuration (default offset mode with page/startValue/increment), and all results are accumulated. Each item is output as { json: item }. When debug is enabled, a __debugLog entry may be prepended to the return array.

Examples

Example 1: Fetch a single page of partner usage

Set partnerId to your Phin Partner ID and leave returnAll disabled (default). The node makes one GET request to /partners/{partnerId}/billing/usage and returns the first page of results.

Example 2: Fetch all partner usage pages

Set partnerId to your Phin Partner ID and enable returnAll. The node iterates through pages using offset pagination (default mode), accumulating all results. Adjust pagination parameters (pageSize, maxPages, requestInterval) as needed.

Links

Discussion