List Form Templates - Penbox Documentation

GET

form_templates

List Form Templates

curl --request GET \
  --url https://connect.penbox.io/v1/form_templates \
  --header 'Authorization: Bearer <token>'

{
  "meta": {
    "total_count": 123,
    "total_pages": 123,
    "page_size": 123,
    "current_page": 123
  },
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "slug": "<string>",
      "name": "<string>",
      "archived_at": "2023-11-07T05:31:56Z",
      "enabled": true
    }
  ]
}

Retrieve all active form templates available in the authorized workspaces.

Only enabled and published templates are returned by this endpoint. Archived or disabled templates require the ?archived=true query parameter.

Cache template information to improve performance. Template configurations don’t change frequently, so you can refresh this data periodically (e.g., hourly or daily).

Template slugs can be reused across different workspaces. Always combine the template slug with the workspace slug when storing or referencing templates in your system.

Authorizations

Authorization

string

header

required

API token (starts with pnbx_). Create at https://app.penbox.io/workspace/settings/api. Include as: Authorization: Bearer {token}

Query Parameters

archived

boolean

default:false

Include archived form templates when true

page[number]

integer

default:1

Page number (starts at 1)

Required range: x >= 1

page[size]

integer

default:10

Number of items per page (max: 100)

Required range: 1 <= x <= 100

sort

enum<string>

default:-created_at

Sort field (prefix with - for descending). Allowed values: created_at, updated_at

Available options:

+created_at,

-created_at,

+updated_at,

-updated_at

Response

200 - application/json

Successful response