Articles on: Account Settings

πŸ”Œ How to Use the PodPitch Read-Only API

How to Use the PodPitch Read-Only API


The PodPitch API provides read-only access to campaign and media-match data. It is designed for reporting, dashboards, business-intelligence tools, and internal assistants that need to retrieve information without changing your PodPitch account.


The API cannot create campaigns, edit records, send pitches, or change settings.


Find your API details


  1. Open Settings.
  2. Open API.
  3. Review the base URL, authentication instructions, and examples shown for your account.


Use the live API page as the source of truth for authentication. Do not share API credentials in helpdesk tickets, screenshots, public repositories, or browser links.


Available campaign requests


List campaigns


Use:


GET /api/v1/campaigns


The request can return campaigns and can support filters shown in the API documentation, such as campaign status or a partial profile name.


Campaign statuses can include:


  • Active
  • Manual
  • Off
  • Archived


Retrieve one campaign


Use:


GET /api/v1/campaigns/:id


Replace :id with the campaign identifier returned by the campaign list.


Retrieve media matches for a campaign


Use:


GET /api/v1/campaigns/:id/podcasts


The endpoint can support the status values documented on the API page, including:


  • not_sent
  • in_progress
  • replied
  • paused
  • skipped
  • finished
  • booked
  • appeared
  • opened


Use limit and offset for pagination. The API page currently documents a limit range of 1–250, with 50 as the default. Recheck the live documentation before building a fixed integration.


Common uses


The API can support:


  • internal campaign dashboards;
  • scheduled reporting;
  • business-intelligence analysis;
  • campaign and match audits; and
  • read-only tools that summarize account activity.


Security and reliability


  • Store credentials in a secure secret manager.
  • Give credentials only to people and systems that need them.
  • Do not put credentials in URLs or client-side code.
  • Handle pagination and empty results.
  • Expect documented fields to be absent when data is unavailable.
  • Test integrations against a small result set first.


Troubleshooting


If a request fails:


  1. confirm that you are using the base URL shown in Settings β†’ API;
  2. confirm that authentication is included exactly as documented;
  3. verify the campaign ID;
  4. check the status, limit, and offset values; and
  5. record the response status and error message without copying credentials.


Contact Support through dashboard chat with the endpoint, response status, and sanitized error message.

Updated on: 27/08/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!