Skip to main content
Welcome to the Penbox Connect API reference documentation. This section provides interactive API documentation automatically generated from our OpenAPI specification.

​
Base URL

All API endpoints use the base URL: https://connect.penbox.io/v1

​
Authentication

All API requests require authentication using OAuth2 Bearer tokens: 
Authorization: Bearer {access_token}
Learn how to obtain access tokens in the Authentication guide.

​
Available Resources

Forms

Create and manage forms, responses, and templates

Files

Download uploaded files (API: attachments)

Workspaces

List authorized workspaces (API: companies)

​
Business vs Technical Terminology

Penbox uses business-friendly terms in the UI, but the API uses technical names for consistency:
Business TermAPI TermDescription
WorkspacecompanyYour Penbox workspace or organization
FormrequestA form sent to a contact to fill out
Form TemplateflowA reusable form template configuration
Form ResponseresponseData submitted by a contact
FileattachmentA file uploaded through a form
Throughout this documentation, we’ll use business terms in headings but show the technical API names in code examples.

​
Response Format

The Connect API returns data directly in a flat structure (not JSON:API format): Single Resource: 
{
  "id": "uuid",
  "created_at": "2025-01-23T13:20:00Z",
  "status": "completed",
  "archived": false,
  "user": { "email": "...", "given_name": "..." },
  "flow": { "slug": "..." },
  "links": { "fill": "...", "app": "..." },
  "data": {},
  "responses": [],
  "notifications": []
}
Collections: 
[
  { "id": "uuid-1", "created_at": "...", "status": "..." },
  { "id": "uuid-2", "created_at": "...", "status": "..." }
]
Error Responses: 
{
  "errors": [
    {
      "status": "404",
      "title": "Not Found",
      "detail": "The requested resource was not found"
    }
  ]
}

​
Rate Limits

  • 100 requests per minute per access token
  • 1,000 requests per hour per client

​
Getting Started

1

Get OAuth Credentials

Contact Penbox to receive your client_id and client_secretLearn about Authentication →
2

Authorize Users

Implement the OAuth2 flow to get access tokensSee Authentication Flow →
3

Make API Calls

Use the interactive API reference to explore endpointsBrowse API Endpoints →

​
Additional Resources

Authentication

OAuth2 authentication guide

Advanced Filters

Powerful filtering and query options

Connect API Guide

Complete guide with examples and use cases

Error Handling

Handle API errors properly

​
Need Help?

  • Documentation: Browse the sections in this guide
  • Email: [email protected]
  • Status: status.penbox.io