GET /api/v1/whoami
Check a token
The workspace and token this request is authenticated as. The first call any integration should make. Read only.
Read one workspace's sales figures live: calls, outcomes, cash, leads, attribution, funnels and webinars. Every endpoint is read only. PYLO stays the system of record, and nothing that uses this API can change it.
Authorization: Bearer <token>./api/v1/whoami first. It names the workspace the token reads.The OpenAPI 3.0 description: https://www.pylosystem.com/api/public/openapi.json
API base: https://api.pylosystem.com
GET /api/v1/whoami
Check a token
The workspace and token this request is authenticated as. The first call any integration should make. Read only.
GET /api/v1/calls
Call figures
Calls booked, taken, closed and the rates between them, for the period, each with both sides of every rate. Read only.
from. First day, YYYY-MM-DD. Defaults to 29 days before `to`.to. Last day, YYYY-MM-DD. Defaults to today.GET /api/v1/outcomes
Call outcomes
Every call outcome in the period, counted. Read only.
from. First day, YYYY-MM-DD. Defaults to 29 days before `to`.to. Last day, YYYY-MM-DD. Defaults to today.GET /api/v1/payments
Cash and revenue
Cash collected and revenue booked in the period, on the workspace's currency. Read only.
from. First day, YYYY-MM-DD. Defaults to 29 days before `to`.to. Last day, YYYY-MM-DD. Defaults to today.GET /api/v1/leads
Leads
Leads created in the period, newest first, at most 500. Read only.
from. First day, YYYY-MM-DD. Defaults to 29 days before `to`.to. Last day, YYYY-MM-DD. Defaults to today.limit. At most 500; a larger number is capped, not refused.GET /api/v1/leads/{id}/journey
One lead's journey
Everything PYLO holds about one lead, in order: how they arrived, their calls, outcomes and payments. Read only.
id, requiredGET /api/v1/speed-to-lead
Waiting leads
Leads still waiting for a first contact, how long each has waited, and where to open them. Read only.
withinMinutesGET /api/v1/eod
End of day reports
EOD submissions and compliance for the period. Read only.
from. First day, YYYY-MM-DD. Defaults to 29 days before `to`.to. Last day, YYYY-MM-DD. Defaults to today.GET /api/v1/attribution
Attribution
Leads, closes and cash by UTM source, medium, campaign and content. Read only.
from. First day, YYYY-MM-DD. Defaults to 29 days before `to`.to. Last day, YYYY-MM-DD. Defaults to today.GET /api/v1/commission
Commission
Commission owed per member for the period. Read only.
from. First day, YYYY-MM-DD. Defaults to 29 days before `to`.to. Last day, YYYY-MM-DD. Defaults to today.GET /api/v1/funnel
Funnel
One funnel's stages for the period, each with its count and the rate from the stage before. Read only.
from. First day, YYYY-MM-DD. Defaults to 29 days before `to`.to. Last day, YYYY-MM-DD. Defaults to today.funnel. Which funnel. An unknown name answers 400 naming the ones that exist.GET /api/v1/webinar
Webinar
Registrations, attendance, stay to pitch and bookings, for one webinar event or all of them. Read only.
from. First day, YYYY-MM-DD. Defaults to 29 days before `to`.to. Last day, YYYY-MM-DD. Defaults to today.eventId. One webinar event. Omit for all of them.GET /api/v1/audit-events
Audit log
Every write recorded for this workspace in the period, with the actor, the target and the reason. Read only.
from. First day, YYYY-MM-DD. Defaults to 29 days before `to`.to. Last day, YYYY-MM-DD. Defaults to today.