Community Create Account Sign in

Overview
API Reference

Community Create Account Sign in

API Reference Data Clips

Get

GET

https://api.x.flatfile.com/v1/data-clips/:dataClipId

GET

/v1/data-clips/:dataClipId

1 curl https://api.x.flatfile.com/v1/data-clips/dataClipId \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "data": {
3     "id": "id",
4     "name": "name",
5     "sourceSheetId": "sourceSheetId",
6     "clipSheetId": "clipSheetId",
7     "workbookId": "workbookId",
8     "status": "status",
9     "createdBy": "createdBy",
10     "updatedAt": "2024-01-15T09:30:00Z",
11     "createdAt": "2024-01-15T09:30:00Z",
12     "description": "description",
13     "mergedAt": "2024-01-15T09:30:00Z",
14     "deletedAt": "2024-01-15T09:30:00Z",
15     "guestLinkUrl": "guestLinkUrl",
16     "accessToken": "accessToken",
17     "sharedLinkAccess": "sharedLinkAccess"
18   }
19 }

Path parameters

dataClipIdstringRequired

Data Clip ID

Headers

AuthorizationstringRequired

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

X-Disable-Hooks"true"Required

Response

This endpoint returns an object.

dataobject

The list of DataClips.

Was this page helpful?

Add Records To Clip