Jump to Content

Guides API Reference

v1

API Reference

v1Guides API Reference

OneSchema API

API Setup

Templates

Templates
Template Hooks

Importer

Embed resource
Get embedget
Get embedsget
Get imported rows for an embed fileget
Get error summary for an embed fileget
Get imported file url for an embedget
Get uploaded file url for an embedget
Delete an embeddelete

Headless

Create an embedded sessionpost
Upload a CSV or excel file to an embedpost
Set header row on an embed filepost
Set column mapping on an embed filepost
Import an embed filepost

Validation

Validate JSON rowspost
Error codes

Events

Get events for an embedget

Code Hooks (Legacy)

Create post-upload code hookpost
Create post-mapping code hookpost
Create validation code hookpost
Get post-upload code hookget
Get post-mapping code hookget
Get validation code hookget
Delete post-upload code hookdelete
Delete post-mapping code hookdelete
Delete validation code hookdelete

FileFeeds

FileFeeds
FileFeeds Imports
FileFeeds Embed Sessions
- Create FileFeed embed sessionpost
- Upload file to the FileFeed embed sessionpost
FileFeeds (Legacy)
- Get saved mappings for a FileFeedget
- Update FileFeed saved mappingsput

SFTP ACCOUNTS

Create SFTP accountpost
Get SFTP accountget
Get SFTP accountsget
Delete SFTP accountdelete

Sheets

Upload a CSV or Excel filepost
Set the header rowpost
Map sheet columnspost
Get rowsget
Delete a sheetdelete
Export a CSV filepost
Export an Excel filepost
Export a JSON filepost

OneSchema API

API Setup

Templates

Templates
Template Hooks

Importer

Embed resource
Get embedget
Get embedsget
Get imported rows for an embed fileget
Get error summary for an embed fileget
Get imported file url for an embedget
Get uploaded file url for an embedget
Delete an embeddelete

Headless

Create an embedded sessionpost
Upload a CSV or excel file to an embedpost
Set header row on an embed filepost
Set column mapping on an embed filepost
Import an embed filepost

Validation

Validate JSON rowspost
Error codes

Events

Get events for an embedget

Code Hooks (Legacy)

Create post-upload code hookpost
Create post-mapping code hookpost
Create validation code hookpost
Get post-upload code hookget
Get post-mapping code hookget
Get validation code hookget
Delete post-upload code hookdelete
Delete post-mapping code hookdelete
Delete validation code hookdelete

FileFeeds

FileFeeds
FileFeeds Imports
FileFeeds Embed Sessions
- Create FileFeed embed sessionpost
- Upload file to the FileFeed embed sessionpost
FileFeeds (Legacy)
- Get saved mappings for a FileFeedget
- Update FileFeed saved mappingsput

SFTP ACCOUNTS

Create SFTP accountpost
Get SFTP accountget
Get SFTP accountsget
Delete SFTP accountdelete

Sheets

Upload a CSV or Excel filepost
Set the header rowpost
Map sheet columnspost
Get rowsget
Delete a sheetdelete
Export a CSV filepost
Export an Excel filepost
Export a JSON filepost

Get templates

get https://api.oneschema.co/v1/templates

Get templates.

Language

Credentials

Header

URL

Click Try It! to start a request and see the response here!