API referenceMappings
Get mapping
Fetch a single mapping by ID.
Get mapping
Returns one mapping by ID, including its field_mappings dictionary.
Signature
GET /api/v1/mappings/{mapping_id}Permissions
API key scope: read or higher. Caller must own the mapping.
Path parameters
| Name | Type | Description |
|---|---|---|
mapping_id | integer | Mapping ID. |
Example
curl https://api.simplyfill.app/v1/mappings/456 \
-H "Authorization: Bearer $SIMPLYFILL_API_KEY"const mapping = await client.mappings.get(456)mapping = client.mappings.get(456)Response
{
"id": 456,
"name": "Invoice — billing system",
"description": null,
"template_id": 123,
"schema_template_id": null,
"field_mappings": {
"invoice_number": "invoiceId",
"customer_name": "clientName",
"total_amount": "amount"
},
"transformations": {},
"is_template": false,
"user_id": 7,
"organization_id": null,
"created_at": "2026-05-17T15:01:09Z",
"updated_at": null
}Errors
| Status | error code | Cause |
|---|---|---|
404 | mapping_not_found | No mapping with the given ID, or you lack access. |