Mapping

List mapping programs

GET
List all mapping programs

Query parameters

pageSizeintegerOptional
Number of programs to return in a page (default 10)
pageNumberintegerOptional
Based on pageSize, which page of records to return
createdBystringOptional
Filter by creator
createdAfterdatetimeOptional
Filter by creation time
createdBeforedatetimeOptional
Filter by creation time
environmentIdstringOptional
The ID of the environment
familyIdstringOptional
Filter by family
namespacestringOptional
Filter by namespace
sourceKeysstringOptional
Filter by source keys
destinationKeysstringOptional
Filter by destination keys

Response

This endpoint returns an object
data
list of objects

Errors

GET
$curl -G https://api.x.flatfile.com/v1/mapping \
>     -H "X-Disable-Hooks: true" \
>     -H "Authorization: Bearer <token>" \
>     -d pageSize=0 \
>     -d pageNumber=0
Response
1{
2  "data": [
3    {
4      "rules": [
5        {
6          "name": "string",
7          "type": "string",
8          "acceptedAt": "2023-01-01T00:00:00Z",
9          "acceptedBy": "string",
10          "confidence": 0,
11          "config": {},
12          "createdAt": "2023-01-01T00:00:00Z",
13          "createdBy": "string",
14          "deletedAt": "2023-01-01T00:00:00Z",
15          "id": "string",
16          "updatedAt": "2023-01-01T00:00:00Z"
17        }
18      ],
19      "sourceKeys": [
20        "string"
21      ],
22      "destinationKeys": [
23        "string"
24      ],
25      "id": "string",
26      "namespace": "string",
27      "familyId": "string",
28      "createdAt": "2023-01-01T00:00:00Z",
29      "createdBy": "string",
30      "summary": {
31        "totalRuleCount": 0,
32        "addedRuleCount": 0,
33        "deletedRuleCount": 0
34      },
35      "accessToken": "string"
36    }
37  ]
38}
Built with