API referenceMappings
List mappings
Return the mappings owned by the authenticated user, optionally filtered by template.
List mappings
Lists all mappings owned by the authenticated user.
Signature
GET /api/v1/mappingsPermissions
API key scope: read or higher.
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
template_id | integer | no | Restrict results to mappings of a single template. |
skip | integer | no | Records to skip. Default 0. |
limit | integer | no | Max records to return. Default 100. |
Example
curl "https://api.simplyfill.app/v1/mappings?template_id=123" \
-H "Authorization: Bearer $SIMPLYFILL_API_KEY"const { mappings, total } = await client.mappings.list({ templateId: 123 })result = client.mappings.list(template_id=123)Response
{
"mappings": [
{
"id": 456,
"name": "HR app — onboarding",
"description": "Aliases the W-4 to our HR data shape.",
"template_id": 123,
"schema_template_id": null,
"field_mappings": {
"topmostSubform[0].Page1[0].f1_02[0]": "fullName",
"topmostSubform[0].Page1[0].f1_06[0]": "ssn"
},
"transformations": {},
"is_template": false,
"created_at": "2026-05-01T11:09:54Z",
"updated_at": "2026-05-02T09:01:11Z"
}
],
"total": 1
}