CommunityCreate AccountSign in
  • Overview
    • Welcome
    • Authentication
    • Using Environments
  • API Reference
LogoLogo
LogoLogo
CommunityCreate AccountSign in
API ReferenceSheets

GET
https://api.x.flatfile.com/v1/sheets/:sheetId
GET
/v1/sheets/:sheetId
1curl https://api.x.flatfile.com/v1/sheets/us_sh_YOUR_ID \
2 -H "X-Disable-Hooks: true" \
3 -H "Authorization: Bearer <token>"
Try it
200Example0
1{
2 "data": {
3 "id": "us_sh_YOUR_ID",
4 "workbookId": "us_wb_YOUR_ID",
5 "name": "Contacts",
6 "slug": "contacts",
7 "config": {
8 "name": "Contacts",
9 "fields": [
10 {
11 "type": "string",
12 "key": "firstName",
13 "label": "First Name"
14 },
15 {
16 "type": "string",
17 "key": "lastName",
18 "label": "Last Name"
19 },
20 {
21 "type": "string",
22 "key": "email",
23 "label": "Email"
24 }
25 ],
26 "slug": "contacts",
27 "mappingConfidenceThreshold": 0.5
28 },
29 "updatedAt": "2021-08-31T18:00:00Z",
30 "createdAt": "2021-08-31T18:00:00Z",
31 "metadata": {
32 "rowHeaders": [
33 4
34 ]
35 }
36 }
37}
Was this page helpful?
Previous

Delete a sheet

Next
Built with
Returns a sheet in a workbook
Get a sheet

Authentication

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

Path parameters

sheetIdstringRequired
ID of sheet

Headers

X-Disable-Hooks"true"RequiredDefaults to true

Response

This endpoint returns an object.
dataobject
A place to store tabular data

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