Jump to Content

Support Feedback Changelog

Developer Guides API Reference Announcements

Support Feedback Changelog Log In

API Reference

Developer Guides API Reference Announcements

All

Pages

Start typing to search…

REST API

Introduction
Authentication
Timestamps
Unique IDs
Pagination
Libraries
AWS Interactions
Working with the Australian or European Instances
OpenAPI and Postman Collection

QUERY

Introduction
Fulcrum Query Functions
GET Queryget
POST Querypost

USERS

Users API
Get User Informationget

AUTHORIZATIONS

Authorizations API
Get All Authorizationsget
Get Single Authorizationget
Create Authorizationpost
Update Authorizationput
Delete Authorizationdelete

ROLES

Roles API
Get All Rolesget

MEMBERSHIPS

Memberships API
Get All Membershipsget
Get Single Membershipget
Get Membership Permissionsget
Change Permissionspost
Create Memberpost
Update Memberput
Delete Memberdelete

GROUPS

Groups API
Get All Groupsget
Get Single Groupget
Get Group Resourceget
Create Grouppost
Update Group Permissionspost
Update Group Name / Descriptionput
Delete Groupdelete

FORMS

Forms API
Get All Formsget
Get Single Formget
Get Form Historyget
Create Formpost
Update Formput
Delete Formdelete

RECORDS

Records API
Get All Recordsget
Get Single Recordget
Get Record Historyget
Get All Records Historyget
Create Recordpost
Update Recordput
Delete Recorddelete

CHOICE LISTS

Choice Lists API
Get All Choice Listsget
Get Single Choice Listget
Create Choice Listpost
Update Choice Listput
Delete Choice Listdelete

CLASSIFICATION SETS

Classification Sets API
Get All Classification Setsget
Get Single Classification Setget
Create Classification Setpost
Update Classification Setput
Delete Classification Setdelete

PROJECTS

Projects API
Get All Projectsget
Get Single Projectget
Create Projectpost
Update Projectput
Delete Projectdelete

LAYERS

Layers API
Get All Layersget
Get Single Layerget
Upload a Layerget
Create Layerpost
Update Layerput
Delete Layerdelete

PHOTOS

Photos API
Get All Photosget
Get Single Photo Metadataget
- Photo Thumbnail Metadataget
- Photo Large Metadataget
Get Single Photo Fileget
- Photo Thumbnail Fileget
- Photo Large Fileget
Upload Photopost

SIGNATURES

Signatures API
Get All Signaturesget
Get Single Signature Metadataget
- Signature Thumbnail Metadataget
Get Single Signature Fileget
- Signature Thumbnail Fileget
Upload Signaturepost

VIDEOS

Videos API
Get All Videosget
Get Original Video Fileget
Get Small Video Fileget
Get Medium Video Fileget
Get Small Video Thumbnailget
- Get Small Square Video Thumbnailget
Get Medium Video Thumbnailget
- Get Medium Square Video Thumbnailget
Get Large Video Thumbnailget
- Get Large Square Video Thumbnailget
Get Huge Video Thumbnailget
- Get Huge Square Video Thumbnailget
Upload Videopost

AUDIO

Audio API
Get All Audioget
Get Original Audio Fileget
Upload Audiopost

ATTACHMENTS

Attachments API
Get All Attachmentsget
Get Single Attachmentget
Create Attachmentpost
Finalize Attachmentpost
Delete Attachmentdelete

CHANGESETS

Changesets API
Get All Changesetsget
Get Single Changesetget
Create Changesetpost
Update Changesetput
Close Changesetput

WEBHOOKS

Webhooks API
Get All Webhooksget
Get Single Webhookget
Create Webhookpost
Update Webhookput
Delete Webhookdelete

AUDIT LOGS

Audit Logs API
Get All Audit Logsget
Get Single Audit Logget

WORKFLOWS

Workflows API
Get All Workflowsget
Get Single Workflowget
Create Workflowpost
Update Workflowput
Delete Workflowdelete

BATCH OPERATIONS

Batch API
Get All Batchesget
Get Single Batchget
Create Batch to Bulk Update Recordspost
Create Batch to Bulk Delete Recordspost
Add batch operationspost
Start Batchpost

REPORT TEMPLATES

Report Templates API
Get All Report Templatesget
Get Single Report Templateget
Create Report Templatepost
Update Report Templateput
Delete Report Templatedelete

Reports

Reports API
Get PDF Reportget

Start Batch

post https://api.fulcrumapp.com/api/v2/batch/{batch_id}/start.json

Start your pending batch

Language

Credentials

Header

URL

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