/api/v1/developer/* so lenders and collectors can plug PathPilot into their existing systems. This page is a high-level catalog. Full request and response schemas, base URLs, and API keys are provided after you request access.
Authentication
Every developer endpoint is authenticated with an organization API key passed on the request. Requests are scoped to the calling organization, so you only ever see and modify your own campaigns, attempts, and results.API keys are issued after you request access at getpathpilot.com. Do not share or commit keys.
Endpoint catalog
List Agents
GET /api/v1/developer/agentsReturn the operational voice agents your organization can assign to campaigns.Import Campaign
POST /api/v1/developer/campaigns/importUpload a customer file to create or enrich a campaign. Supports provider and creditor hints, dry-run validation, and a target agent.Get Job
GET /api/v1/developer/jobs/{job_id}Poll the status of an async import or run job started by another developer endpoint.Trigger Campaign Run
POST /api/v1/developer/campaigns/{campaign_id}/runKick off a run for an existing campaign. Returns a job ID and a status URL to poll.Suppress Contacts
POST /api/v1/develop/campaigns/{campaign_id}/do_not_callAdd customers to the do-not-call list for a specific campaign so future attempts skip them.List Call Results
GET /api/v1/developer/resultsPaginated call results for a campaign, sortable by response code and other fields. Includes summary aggregates.Typical integration flow
1
List available agents
Call
GET /api/v1/developer/agents to discover which voice agents your org can attach to campaigns.2
Import your customer list
Send
POST /api/v1/developer/campaigns/import with the file and the target agent_id. You get back a job ID.3
Poll the job
Use
GET /api/v1/developer/jobs/{job_id} until the import completes.4
Run the campaign
Call
POST /api/v1/developer/campaigns/{campaign_id}/run to start dialing. Suppress specific contacts with the do_not_call endpoint as needed.5
Pull results
Read paginated outcomes and summaries from
GET /api/v1/developer/results.Get full documentation and credentials
Request access at getpathpilot.com
Sign up to receive API keys, sandbox credentials, and full endpoint documentation including request bodies, response schemas, error codes, and rate limits.