For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Community Create Account Sign in

API Reference Mapping

Get a mapping rule

GET

https://api.x.flatfile.com/v1/mapping/:programId/rules/:mappingId

GET

/v1/mapping/:programId/rules/:mappingId

$ curl https://api.x.flatfile.com/v1/mapping/us_mp_YOUR_ID/rules/us_mr_YOUR_ID \
>      -H "X-Disable-Hooks: true" \
>      -H "Authorization: Bearer <token>"

1 {
2   "data": {
3     "createdAt": "2021-01-01T00:00:00Z",
4     "id": "mapping-rule-id",
5     "name": "Assign mapping rule",
6     "type": "assign",
7     "updatedAt": "2021-01-01T00:00:00Z",
8     "confidence": 1,
9     "config": {},
10     "createdBy": "us_usr_YOUR_ID",
11     "metadata": {}
12   }
13 }

Get a mapping rule from a program

Was this page helpful?

Update a mapping rule

Overview
API Reference

Community Create Account Sign in

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

programIdstringRequired

ID of the program

mappingIdstringRequired

ID of mapping rule

Headers

X-Disable-Hooks"true"Required

Response

This endpoint returns an object.

dataobject

Errors

400

Bad Request Error

404

Not Found Error