Get a draft

GET

https://api.x.flatfile.com/v1/spaces/:spaceId/drafts/:draftSpaceId/merge

GET

/v1/spaces/:spaceId/drafts/:draftSpaceId/merge

1 import requests
2 
3 url = "https://api.x.flatfile.com/v1/spaces/spaceId/drafts/draftSpaceId/merge"
4 
5 headers = {
6     "X-Disable-Hooks": "true",
7     "Keep-Alive": "timeout=200",
8     "Authorization": "Bearer <token>"
9 }
10 
11 response = requests.get(url, headers=headers)
12 
13 print(response.json())

Try it

200Retrieved

1 {
2   "data": {
3     "space": [
4       {
5         "action": "action",
6         "id": "id",
7         "mergeId": "mergeId",
8         "jsonPatch": [
9           {
10             "op": "add",
11             "from": "from",
12             "path": "path",
13             "value": {
14               "key": "value"
15             }
16           },
17           {
18             "op": "add",
19             "from": "from",
20             "path": "path",
21             "value": {
22               "key": "value"
23             }
24           }
25         ]
26       },
27       {
28         "action": "action",
29         "id": "id",
30         "mergeId": "mergeId",
31         "jsonPatch": [
32           {
33             "op": "add",
34             "from": "from",
35             "path": "path",
36             "value": {
37               "key": "value"
38             }
39           },
40           {
41             "op": "add",
42             "from": "from",
43             "path": "path",
44             "value": {
45               "key": "value"
46             }
47           }
48         ]
49       }
50     ],
51     "workbook": [
52       {
53         "action": "action",
54         "id": "id",
55         "mergeId": "mergeId",
56         "jsonPatch": [
57           {
58             "op": "add",
59             "from": "from",
60             "path": "path",
61             "value": {
62               "key": "value"
63             }
64           },
65           {
66             "op": "add",
67             "from": "from",
68             "path": "path",
69             "value": {
70               "key": "value"
71             }
72           }
73         ]
74       },
75       {
76         "action": "action",
77         "id": "id",
78         "mergeId": "mergeId",
79         "jsonPatch": [
80           {
81             "op": "add",
82             "from": "from",
83             "path": "path",
84             "value": {
85               "key": "value"
86             }
87           },
88           {
89             "op": "add",
90             "from": "from",
91             "path": "path",
92             "value": {
93               "key": "value"
94             }
95           }
96         ]
97       }
98     ],
99     "sheet": [
100       {
101         "action": "action",
102         "id": "id",
103         "mergeId": "mergeId",
104         "jsonPatch": [
105           {
106             "op": "add",
107             "from": "from",
108             "path": "path",
109             "value": {
110               "key": "value"
111             }
112           },
113           {
114             "op": "add",
115             "from": "from",
116             "path": "path",
117             "value": {
118               "key": "value"
119             }
120           }
121         ]
122       },
123       {
124         "action": "action",
125         "id": "id",
126         "mergeId": "mergeId",
127         "jsonPatch": [
128           {
129             "op": "add",
130             "from": "from",
131             "path": "path",
132             "value": {
133               "key": "value"
134             }
135           },
136           {
137             "op": "add",
138             "from": "from",
139             "path": "path",
140             "value": {
141               "key": "value"
142             }
143           }
144         ]
145       }
146     ],
147     "guidance": [
148       {
149         "action": "action",
150         "id": "id",
151         "mergeId": "mergeId",
152         "jsonPatch": [
153           {
154             "op": "add",
155             "from": "from",
156             "path": "path",
157             "value": {
158               "key": "value"
159             }
160           },
161           {
162             "op": "add",
163             "from": "from",
164             "path": "path",
165             "value": {
166               "key": "value"
167             }
168           }
169         ]
170       },
171       {
172         "action": "action",
173         "id": "id",
174         "mergeId": "mergeId",
175         "jsonPatch": [
176           {
177             "op": "add",
178             "from": "from",
179             "path": "path",
180             "value": {
181               "key": "value"
182             }
183           },
184           {
185             "op": "add",
186             "from": "from",
187             "path": "path",
188             "value": {
189               "key": "value"
190             }
191           }
192         ]
193       }
194     ],
195     "document": [
196       {
197         "action": "action",
198         "id": "id",
199         "mergeId": "mergeId",
200         "jsonPatch": [
201           {
202             "op": "add",
203             "from": "from",
204             "path": "path",
205             "value": {
206               "key": "value"
207             }
208           },
209           {
210             "op": "add",
211             "from": "from",
212             "path": "path",
213             "value": {
214               "key": "value"
215             }
216           }
217         ]
218       },
219       {
220         "action": "action",
221         "id": "id",
222         "mergeId": "mergeId",
223         "jsonPatch": [
224           {
225             "op": "add",
226             "from": "from",
227             "path": "path",
228             "value": {
229               "key": "value"
230             }
231           },
232           {
233             "op": "add",
234             "from": "from",
235             "path": "path",
236             "value": {
237               "key": "value"
238             }
239           }
240         ]
241       }
242     ],
243     "action": [
244       {
245         "action": "action",
246         "id": "id",
247         "mergeId": "mergeId",
248         "jsonPatch": [
249           {
250             "op": "add",
251             "from": "from",
252             "path": "path",
253             "value": {
254               "key": "value"
255             }
256           },
257           {
258             "op": "add",
259             "from": "from",
260             "path": "path",
261             "value": {
262               "key": "value"
263             }
264           }
265         ]
266       },
267       {
268         "action": "action",
269         "id": "id",
270         "mergeId": "mergeId",
271         "jsonPatch": [
272           {
273             "op": "add",
274             "from": "from",
275             "path": "path",
276             "value": {
277               "key": "value"
278             }
279           },
280           {
281             "op": "add",
282             "from": "from",
283             "path": "path",
284             "value": {
285               "key": "value"
286             }
287           }
288         ]
289       }
290     ],
291     "agent": [
292       {
293         "action": "action",
294         "id": "id",
295         "mergeId": "mergeId",
296         "jsonPatch": [
297           {
298             "op": "add",
299             "from": "from",
300             "path": "path",
301             "value": {
302               "key": "value"
303             }
304           },
305           {
306             "op": "add",
307             "from": "from",
308             "path": "path",
309             "value": {
310               "key": "value"
311             }
312           }
313         ]
314       },
315       {
316         "action": "action",
317         "id": "id",
318         "mergeId": "mergeId",
319         "jsonPatch": [
320           {
321             "op": "add",
322             "from": "from",
323             "path": "path",
324             "value": {
325               "key": "value"
326             }
327           },
328           {
329             "op": "add",
330             "from": "from",
331             "path": "path",
332             "value": {
333               "key": "value"
334             }
335           }
336         ]
337       }
338     ]
339   }
340 }

Gets a draft by the space id and draft space id

Authentication

AuthorizationBearer

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

Path Parameters

spaceIdstringRequired

ID of space to get draft for

draftSpaceIdstringRequired

ID of draft space to get

Response

This endpoint returns an object.

dataobject

Get a draft

Authentication

Path Parameters

Headers

Response

Errors