List forms

Returns a paginated list of forms belonging to a customer. Supports filtering by form ID, title/description search, and archived/active state, plus ordering and pagination.

GET /api/forms

List forms

cURL

curl --request GET \
  --url https://api.paubox.com/v1/forms/api/forms \
  --header 'Authorization: Bearer <token>'

200

{
  "results": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "title": "Patient Intake Form",
      "description": "Please complete before your appointment.",
      "form_html": "<form>...</form>",
      "form_json": {},
      "form_css": "form { font-family: sans-serif; }",
      "vanity_url": null,
      "version": 2,
      "active": true,
      "customer_id": 123,
      "old_form_id": null,
      "recipient": "[e-mail],[e-mail]",
      "signable": false,
      "signature_confirmation_label": null,
      "submission_count": 42,
      "type": null,
      "subscription_list_id": null,
      "deleted": false,
      "archived": false,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-06-01T08:00:00Z"
    }
  ],
  "page_info": {
    "count": 1,
    "pages": 1,
    "page": 1,
    "items": 50
  }
}

Authorizations

Authorization · string · header · required

Paubox API key sent as Authorization: Bearer YOUR_API_KEY. API keys are created in the Paubox dashboard and must have the "forms" scope; a key without the forms scope receives 401 Unauthorized. A valid key used against a resource that belongs to a different customer receives 403 Forbidden.

Query Parameters

customer_id · integer · required

Your Paubox customer ID. Requests for a customer you do not have access to return 403.

form_id · string<uuid>

Filter the results to a single form by its UUID.

search · string

Substring match against the form title or description.

archived · boolean

Filter by archived state.

active · boolean

Filter by active state.

order_by · enum<string> · default: created_at

Field to order results by. Unknown values fall back to created_at.

Available options: created_at, title, updated_at, submission_count

order · enum<string> · default: desc

Sort direction.

Available options: asc, desc

page · integer · default: 1

Page number to return.

items · integer · default: 50

Number of forms per page (maximum 100).

Required range: x <= 100

Response

200

application/json

Paginated list of forms

results · object[]

Show child attributes

page_info · object

Show child attributes