Skip to main content
GET
/
v1
/
edits
/
templates
from retab import Retab

client = Retab()
templates = client.edits.templates.list(limit=20, order="desc")
for template in templates.data:
    print(f"{template.id}: {template.name} ({template.field_count} fields)")

{
  "data": [
    {
      "id": "edittplt_abc123",
      "name": "W-9 Form",
      "file": {
        "id": "file_6dd6eb00688ad8d1",
        "filename": "w9_empty.pdf",
        "mime_type": "application/pdf"
      },
      "form_fields": [],
      "field_count": 7,
      "created_at": "2024-03-15T10:30:00Z",
      "updated_at": "2024-03-15T10:30:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": "edittplt_abc123",
    "total_count": 3
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.retab.com/llms.txt

Use this file to discover all available pages before exploring further.

List templates registered for your organization. form_fields is omitted from the list response for performance — fetch a single template with GET /v1/edits/templates/{template_id} to see the full field list. 
from retab import Retab

client = Retab()
templates = client.edits.templates.list(limit=20, order="desc")
for template in templates.data:
    print(f"{template.id}: {template.name} ({template.field_count} fields)")

{
  "data": [
    {
      "id": "edittplt_abc123",
      "name": "W-9 Form",
      "file": {
        "id": "file_6dd6eb00688ad8d1",
        "filename": "w9_empty.pdf",
        "mime_type": "application/pdf"
      },
      "form_fields": [],
      "field_count": 7,
      "created_at": "2024-03-15T10:30:00Z",
      "updated_at": "2024-03-15T10:30:00Z"
    }
  ],
  "list_metadata": {
    "before": null,
    "after": "edittplt_abc123",
    "total_count": 3
  }
}

​
Query Parameters

​
before
string
Cursor for backward pagination.
​
after
string
Cursor for forward pagination.
​
limit
integer
default:"10"
Maximum number of templates to return. Max: 100.
​
order
string
default:"desc"
Sort order. Valid values: asc, desc.
​
name
string
Case-insensitive substring filter on name.
​
sort_by
string
default:"created_at"
Field to sort by. Accepted values: created_at, name.

Authorizations

​
Api-Key
string
header
required

Query Parameters

​
before
string | null
​
after
string | null
​
limit
integer
default:10
Required range: 1 <= x <= 100
​
order
enum<string>
default:desc
Available options:
asc,
desc
​
name
string | null
​
sort_by
string
default:created_at

Response

Successful Response

​
data
any[]
required
​
list_metadata
ListMetadata · object
required