| REST API Reference https://api.pairfon.com   Bearer Token Auth
POST Login
POSThttps://api.pairfon.com/auth/login
Authorization
🔓 No authentication required
Request Body
ParameterTypeRequiredDescription
emailstringrequiredCompany admin email address
passwordstringrequiredAccount password (min 8 chars)
POST Refresh Token
POSThttps://api.pairfon.com/auth/token
Authorization
🔓 No authentication required
Request Body
ParameterTypeRequiredDescription
refreshTokenstringrequiredRefresh token received at login
GET Get Current API Key
GEThttps://api.pairfon.com/auth/api-key
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Returns the current API key and its creation date.

POST Regenerate API Key
POSThttps://api.pairfon.com/auth/api-key/regenerate
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Invalidates the previous key and returns a new one.

POST Create Company
POSThttps://api.pairfon.com/register
Authorization
🔓 No authentication required
Request Body
ParameterTypeRequiredDescription
company.namestringrequiredCompany display name
company.phonestringrequiredCompany phone number
company.addressstringoptionalStreet address
company.citystringoptionalCity
company.countrystringoptionalCountry code (e.g. PK, US)
owner.firstNamestringrequiredOwner first name
owner.lastNamestringrequiredOwner last name
owner.emailstringrequiredOwner email address
owner.passwordstringrequiredPassword (min 8 chars, 1 uppercase, 1 number)
owner.phonestringoptionalOwner phone number
GET Verify Email
GEThttps://api.pairfon.com/register/verify-email?token=
Authorization
🔓 No authentication required
Query Parameters
ParameterTypeRequiredDescription
tokenstringrequiredEmail verification token from signup email
POST Forgot Password
POSThttps://api.pairfon.com/forgot-password
Authorization
🔓 No authentication required
Request Body
ParameterTypeRequiredDescription
emailstringrequiredEmail address to send reset link to
POST Reset Password
POSThttps://api.pairfon.com/reset-password
Authorization
🔓 No authentication required
Request Body
ParameterTypeRequiredDescription
tokenstringrequiredPassword reset token from email
passwordstringrequiredNew password (min 8 chars)
GET Get Current User Profile
GEThttps://api.pairfon.com/profile
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Returns authenticated user's profile data.

PUT Update Profile
PUThttps://api.pairfon.com/profile/:user_id
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN
Request Body
ParameterTypeRequiredDescription
firstNamestringoptionalUser's first name
lastNamestringoptionalUser's last name
phonestringoptionalUser's phone number
GET List Team Members
GEThttps://api.pairfon.com/users
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Returns all users in the authenticated company.

POST Invite User
POSThttps://api.pairfon.com/users
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN
Request Body
ParameterTypeRequiredDescription
firstNamestringrequiredInvitee's first name
lastNamestringrequiredInvitee's last name
emailstringrequiredInvitee's email address
phonestringoptionalInvitee's phone number
rolestringrequiredadmin or member
PUT Update User
PUThttps://api.pairfon.com/users/:id
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN
Request Body
ParameterTypeRequiredDescription
firstNamestringoptionalUpdated first name
lastNamestringoptionalUpdated last name
rolestringoptionaladmin or member
DELETE Remove User
DELETEhttps://api.pairfon.com/users/:id
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Removes the specified user from the company.

GET Get Company Profile
GEThttps://api.pairfon.com/company
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Returns the company profile for the authenticated user's organization.

PUT Update Company
PUThttps://api.pairfon.com/company/:id
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN
Request Body
ParameterTypeRequiredDescription
namestringoptionalCompany display name
phonestringoptionalCompany phone number
addressstringoptionalStreet address
citystringoptionalCity
statestringoptionalState / province
countrystringoptionalCountry code
GET Dashboard Overview
GEThttps://api.pairfon.com/app/home
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Returns summary cards: total messages sent, active devices, credits used, and recent activity.

GET SMS Analytics
GEThttps://api.pairfon.com/dashboard/stats?users=&devices=
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN
Query Parameters
ParameterTypeRequiredDescription
usersstringoptionalComma-separated user IDs to filter by
devicesstringoptionalComma-separated device fingerprints to filter by
GET Device List (Dashboard Filters)
GEThttps://api.pairfon.com/dashboard/devices
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Returns a minimal list of devices (id, name) for use in analytics filter dropdowns.

GET List Paired Devices
GEThttps://api.pairfon.com/device/list
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Returns all Android devices paired to the company account, including online status and SIM details.

POST Send SMS
POSThttps://api.pairfon.com/send-sms
Authorization
🔒 Bearer Token or API Key — Authorization: Bearer YOUR_TOKEN
Request Body

Queues an SMS from a paired Android device. Legacy alias POST /zapier/send-sms is identical (kept for existing Zapier / Pabbly / Make zaps).

ParameterTypeRequiredDescription
device_fingerprintstringrequiredFingerprint of the paired Android device to send from (see GET /device/list)
phonestringrequiredRecipient phone number
messagestringrequiredSMS message body
sim_slotstringoptionalSIM to send from: SIM1 or SIM2. Defaults to SIM1; must match the device's selected SIM
GET Receive SMS
GEThttps://api.pairfon.com/zapier/inbound-sms
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN
Query Parameters

Returns the newest 50 inbound messages. Use GET /zapier/latest-sms for just the single most recent, or register a push webhook (see Save Webhook Config) to have inbound SMS POSTed to your URL.

ParameterTypeRequiredDescription
device_fingerprintstringoptionalFilter to one device
sim_slotstringoptionalFilter to SIM1 / SIM2
POST Send WhatsApp
POSThttps://api.pairfon.com/whatsapp/send
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN
Request Body

Returns 202 queued. The anti-ban governor paces sends and may return 429 when a number is over its cap.

ParameterTypeRequiredDescription
number_idstringrequiredConnected WhatsApp number (see GET /whatsapp/numbers)
tostringrequiredRecipient phone number
contentstringrequired*Message text (*required for text messages)
typestringoptionalDefaults text
media_urlstringoptionalFor media messages
POST Send iMessage
POSThttps://api.pairfon.com/imessage/send
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN
Request Body

Returns 202 queued. Same governor pacing (429 when capped).

ParameterTypeRequiredDescription
handle_idstringrequirediMessage handle / agent (see GET /imessage/handles)
tostringrequiredRecipient phone number or email
contentstringrequiredMessage text
GET Get Webhook Config
GEThttps://api.pairfon.com/webhooks/inbound-sms
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Returns your configured inbound webhook URLs plus the signingSecret (whsec_…) used to verify deliveries. One webhook config covers SMS, WhatsApp, and iMessage — scope each entry with channels / devices / wa_numbers / im_handles.

Every inbound delivery is signed: X-Pairfon-Timestamp + X-Pairfon-Signature: sha256=<hex> where hex = HMAC-SHA256(signingSecret, `${timestamp}.${rawBody}`). Recompute over timestamp + "." + rawBody, constant-time compare, and reject stale timestamps (replay protection).

PUT Save Webhook Config
PUThttps://api.pairfon.com/webhooks/inbound-sms
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN
Request Body
ParameterTypeRequiredDescription
webhooksarrayrequiredArray of webhook objects
webhooks[].urlstringrequiredHTTPS endpoint to POST inbound SMS payloads to
webhooks[].devicesarrayoptionalDevice fingerprints to listen on. Empty = all devices
webhooks[].simsarrayoptionalSIM slots to listen on (0, 1). Empty = all SIMs
GET List Plans
GEThttps://api.pairfon.com/plans
Authorization
🔓 No authentication required — public endpoint

No request body. Returns all publicly available subscription plans with pricing and feature details.

POST Create Checkout Session
POSThttps://api.pairfon.com/billing/checkout-session
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN
Request Body
ParameterTypeRequiredDescription
plan_idstringrequiredPlan identifier from the /plans endpoint
skip_trialbooleanoptionalSet true to skip the free trial period. Default: false
POST Open Billing Portal
POSThttps://api.pairfon.com/billing/portal-session
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Returns a Stripe billing portal URL for managing subscriptions, payment methods, and invoices.

GET Get Subscription Status
GEThttps://api.pairfon.com/subscription
Authorization
🔒 Bearer Token — Authorization: Bearer YOUR_TOKEN

No request body. Returns current plan, billing status, trial end date, and usage limits.