Skip to main content

Quick Reference

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

Forms

Responses

Form Templates

Cases

Case Templates

Attachments

Document Intelligence

Signatures

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:

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

Base URL

All endpoints are relative to:

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