API keys & MCP
Connect AI assistants and automations to PaidFast through the MCP endpoint and organization API keys.
PaidFast can be driven by AI assistants and your own scripts through a built-in MCP (Model Context Protocol) server, authenticated with organization API keys. This lets an assistant answer questions about your business and take safe actions — all scoped to your organization.
#API keys
An API key authenticates calls to PaidFast on behalf of your organization.
- Keys are created under Settings → Integrations (API keys).
- They begin with the prefix
pf_live_. - A key is shown once at creation — copy and store it securely; PaidFast keeps only a hashed version.
- Keys are scoped to your organization and can be revoked instantly if one is ever exposed.
Keep keys secret. Treat an API key like a password. Never paste it into a public place, and revoke and replace any key you think may have leaked.
#The MCP endpoint
Assistants connect to the PaidFast MCP server at:
https://paidfast.online/api/mcp
This is the same endpoint for every organization — it isn't tied to your account or a per-customer domain. Which organization a request acts on is determined entirely by the API key you present, so the URL doesn't change from one business to the next.
Authenticate by presenting your API key as a bearer token:
Authorization: Bearer pf_live_xxxxxxxx
The connection uses the standard MCP Streamable HTTP transport, so any MCP-compatible assistant can discover and call the available tools.
#Available tools
The MCP server exposes a focused, mostly read-only tool set, each governed by a scope:
| Tool | Scope | Purpose |
|---|---|---|
get_business_summary |
— | Snapshot of your receivables |
list_invoices / get_invoice |
invoices:read |
Read invoices |
list_customers |
customers:read |
Read customers |
list_quotations |
quotations:read |
Read quotations |
get_statement |
statements:read |
Read a customer statement |
list_items / list_units_of_measure |
items:read |
Read your price list |
list_due_reminders |
invoices:read |
See what's due to be chased |
create_draft_invoice / update_draft_invoice |
invoices:write |
Draft invoices (never auto-sent) |
duplicate_invoice_as_draft / delete_draft_invoice |
invoices:write |
Manage drafts |
run_due_reminders |
reminders:run |
Trigger due reminders |
Write actions are deliberately limited to drafts and reminders — an assistant can prepare an invoice, but a human still sends it. Tools outside a key's scopes are refused.
#Safe by design
- Every call is scoped to your organization — an assistant can never see another business's data.
- Keys are hashed at rest and instantly revocable.
- Write operations create drafts, not sent documents, so nothing goes to a customer without your action.
#Getting started
- Go to Settings → Integrations and create an API key.
- Copy the
pf_live_…value somewhere safe. - Point your MCP-compatible assistant at
https://paidfast.online/api/mcpwith the key as a bearer token. - Ask it to list your invoices or draft one to confirm the connection.