Skip to main content

​
Quick Reference

This page provides a complete overview of all available API endpoints.

​
Forms

MethodEndpointDescription
GET/v1/formsList forms with filtering and pagination
GET/v1/forms/countCount forms with optional grouping
POST/v1/formsCreate a new form
GET/v1/forms/{id}Get form details and responses
PATCH/v1/forms/{id}Update form status or properties

​
Responses

MethodEndpointDescription
GET/v1/responses/{id}Get response details with attachments

​
Form Templates

MethodEndpointDescription
GET/v1/form_templatesList available form templates
GET/v1/form_templates/{slug}/optionsGet template configuration options
GET/v1/form_templates/{slug}/stepsGet template structure and fields

​
Cases

MethodEndpointDescription
GET/v1/casesList cases with filtering and pagination
GET/v1/cases/countCount cases
POST/v1/casesCreate a new case
GET/v1/cases/{id}Get case details with steps
POST/v1/cases/{id}/dataUpdate case data fields
POST/v1/cases/{id}/contactsUpdate case contacts
POST/v1/cases/{id}/start/{stepKey}Start a case step

​
Case Templates

MethodEndpointDescription
GET/v1/case_templatesList case templates with filtering
GET/v1/case_templates/{id}Get case template details with steps

​
Attachments

MethodEndpointDescription
GET/v1/attachments/{id}Download single attachment
GET/v1/attachmentsDownload multiple attachments as PDF
POST/v1/attachmentsUpload files (JSON or multipart)

​
Document Intelligence

MethodEndpointDescription
POST/v1/document_intelligenceCreate document extraction job
GET/v1/document_intelligence/{id}Get extraction results

​
Signatures

MethodEndpointDescription
GET/v1/signatures/{id}Get signature metadata or download file

​
Workspaces

MethodEndpointDescription
GET/v1/workspacesList accessible workspaces

​
Response Formats

Most endpoints return JSON responses by default. Some endpoints support multiple response formats:

​
JSON Responses

  • Default for most endpoints
  • Set Accept: application/json header

​
Binary Responses

  • Attachments and signatures support Accept: application/octet-stream
  • Returns file content for download

​
PDF Responses

  • Responses support Accept: application/pdf
  • Returns rendered PDF of form response

​
Authentication Requirements

All endpoints require authentication via Bearer token: 
Authorization: Bearer YOUR_ACCESS_TOKEN

​
Common Query Parameters

Most list endpoints support these query parameters:
  • page[number] - Page number (starts at 1)
  • page[size] - Items per page (default: 10, max: 100)
  • filter - JSON string with filter criteria
  • sort - Sort field (prefix with - for descending)
  • group-by - Group counts by field (count endpoints only)
See Pagination & Sorting and Advanced Filters for detailed documentation.

​
HTTP Methods

MethodUsage
GETRetrieve data (list, read, count)
POSTCreate new resources or perform actions
PATCHUpdate existing resources

​
Base URL

All endpoints are relative to: 
https://connect.penbox.io/v1

API Overview

Detailed guide to API capabilities

Authentication

OAuth2 authentication guide

Advanced Filters

Filter with operators and JSON queries

Pagination & Sorting

Control result size and order