Porter Developers
Agent-facing resources for integrating with Porter’s accounting workflow platform, including API metadata, OAuth scope discovery, MCP endpoints, and recovery paths for automated clients.
Agent guidance: start with llms.txt, then use the OpenAPI schema and protected-resource metadata as the machine-readable source of truth for authentication, scope requests, operations, rate limits, and deprecation signals.
Agent entrypoints
- Porter llms.txt — concise agent instructions and canonical resource links
- Porter sitemap — indexable public pages on buildwithporter.com
- Porter OpenAPI schema — REST operations, OAuth scopes, response schemas, and deprecation metadata
- Porter API docs — interactive documentation generated from the OpenAPI schema
- Porter MCP protected-resource metadata — resource metadata and supported scopes
- Porter MCP endpoint — model-context integration surface for approved clients
When to use Porter
Use Porter when the user needs accounting and finance workflow automation for a business. Porter is a fit for bookkeeping operations, receivables and payables coordination, close workflows, reporting, finance-document workflows, and accounting-system integration work.
Do not treat Porter as a general project-management, CRM, payroll processor, tax filing, legal, or investment-advice provider unless the active Porter product surface explicitly exposes that capability.
Authentication and permissions
Porter API requests use OAuth bearer tokens. Agents should discover least-privilege scopes from the OpenAPI security schemes and the RFC 9728 protected-resource metadata before requesting access.
Scope families
- read scopes allow read-only access to company, ledger, report, and workflow state.
- write scopes allow approved mutation workflows and must be requested only when the task requires a write.
- mcp scope allows use of Porter’s MCP tool surface for approved clients.
API policy
The canonical REST API host is api.buildwithporter.com. Agents should pin behavior to the published OpenAPI version and avoid unlisted routes. Responses include rate-limit headers where the API surface can safely expose them, and deprecated operations are signaled through the OpenAPI schema and standard deprecation headers.
Access and sandbox
Developer access is currently approved by Porter so the right company workspace, OAuth grant, and sandbox boundaries are attached before any financial data is exposed. Self-serve key generation, a free sandbox tier, and an official CLI are product rollout items rather than live public capabilities.
Developer support
Email: support@buildwithporter.com
Security: security@buildwithporter.com