Skip to main content

List Templates

The GET /file/designs endpoint returns the templates (designs) in your workspace. Use it to look up the template ID (designId) and latest version you pass to PDF generation without opening the web app. Integrations that let the user pick a template, such as the MCP server, call it.

Endpoint​

  • URL: https://api.re-port-flow.com/v1/file/designs
  • Method: GET
  • Authentication: appkey header, or an OAuth 2.0 access token (Authentication Overview)
  • Rate limit: 100 requests / minute (per workspace)

Examples​

cURL​

# Page 1 (first 30 templates)
curl -X GET https://api.re-port-flow.com/v1/file/designs \
-H "appkey: your-application-key"

# Page 2
curl -X GET "https://api.re-port-flow.com/v1/file/designs?page=2" \
-H "appkey: your-application-key"

Parameters​

ParameterInRequiredDescription
pagequeryNoPage number (1-based). Defaults to page 1. The page size is fixed at 30

Response​

Success (200 OK)​

{
"designs": [
{
"id": "0eUDdgAjNXrrItA2",
"label": "Invoice",
"latestVersion": 3,
"thumbnail": "https://...",
"updatedAt": "2026-10-01T09:00:00.000Z"
}
],
"total": 1,
"page": 1,
"pageSize": 30,
"totalPages": 1
}

The values are illustrative.

FieldTypeDescription
designs[].idstringTemplate ID (16 alphanumeric characters). Use it as designId when generating PDFs
designs[].labelstringTemplate name
designs[].latestVersionintegerLatest version number
designs[].thumbnailstringThumbnail URL
designs[].updatedAtstring (date-time)Last-updated time
totalintegerTotal number of templates
pageintegerCurrent page number (1-based)
pageSizeintegerTemplates per page (fixed at 30)
totalPagesintegerTotal number of pages

To fetch every template, call it with page from 1 up to totalPages.

Errors​

The endpoint can return 400 / 401 / 403 / 412 / 429 / 500. A missing authentication header returns 412. See Error Codes for each code and how to fix it.

Next Steps​