Jump to Content
API Reference
API Reference
API Reference
API Reference
Search
API Reference
Checklists
All
Pages
Start typing to search…
JUMP TO
Introduction
Scanifly API Overview
Generate API Key
Project (Create and Update)
Designs (Create and Get)
Checklists
Service Requests ( Design Services )
Retrieve an Overhead Design Image
Retrieve a Shareable Design Link
Embedding a Public, Read-Only 3D Design Viewer
HTTP Response Codes
Trying the API
Zapier Overview
Supported Integrations
Layout Integrations
Plan Set Integratations
Scanifly API
Users
Update user permissions
patch
Give user admin role
patch
Give user default role
patch
Set folders user is allowed to access
patch
Delete user
del
Add a role to user
post
Remove a role from user
del
Migrate viewMyProjects permission to existing users
post
Folders
Delete many projects from folder
del
Add many projects to folder
patch
Add project to folder
post
Delete project from folder
del
Create a folder
post
Get all company folders
get
Get folder
get
Update folder
patch
Delete folder
del
Company
Get current users company
get
Get current users company members
get
Update company media categories
patch
Delete company media category
del
Create company media category
post
Update company
patch
Update company image
post
Update upload optimization setting
patch
Module Library
Read users module library
get
Update a users module library
put
Read company module library
get
Module library lookup by project
get
Sync modules from the legacy modules-library collection
post
Save/update module library modules
post
Delete a module by moduleId
del
Checklist
Create a new checklist
post
Get filtered checklists
get
Get checklists by project id
get
Get checklist by id
get
Update checklist by id
put
Remove missing media
del
Set checklist status by id
put
Apply patches to a checklist
patch
Get patches for a checklist after a timestamp
get
Checklist Template
Get checklist templates
get
Create a new checklist template
post
Get checklist template by id
get
Update a checklist template
put
Delete a checklist template
del
Import a template
post
Designs
List project designs
get
Get designs by project id
get
Create design on project id
post
Get design by design id
get
Delete design
del
Duplicate design on project id
post
Projects
Get project by id
get
Update project
patch
Create project
post
List projects
get
Media
Media Categories
Get Media Categories for a project
get
Get Media by Category id
get
Get Media by id
get
Service Requests
Create service request
post
Get all existing service requests of a project
get
Create design services statistics data for scanifly admins
get
Reseller
Create a new reseller
post
Get resellers
get
Self service API for resellers to update their JWKS validation endpoint
patch
Update reseller by id
put
Create a new company associated with a reseller, returns the company ID
post
Create a new user associated with a company that the reseller is authorized for, returns the user ID
post
Get list of resellers company can authorize or has authorized
get
Add current user's company to resellers authorized companies list
put
Remove current user's company from resellers authorized companies list
del
Purchase a la carte credits on behalf of another company
post
Lists all credit transactions created by a reseller for their companies.
get
Component Library
Create a new component library entry
post
Get component library entries
get
Update component library entry by id
put
Delete component library entry by id
del
Module Components
Create a new module component
post
Get module components
get
Update module component by id
put
Pandadoc
Create or reuse a default proposal document and return an embed editing session link
post
Send the default proposal document for signing
post
Revert the default proposal document back to draft status
post
List all available PandaDoc templates
get
Set a default PandaDoc template for a company
post
album-media-pdf
/api/v1/album-media-pdf/generate
post
panel-ai
Start panel AI quality workflow.
post
Start panel AI detection workflow.
post
Get panel AI workflow result by workflowId.
get
Scanifly API V1
Energy Sage Estimates
Create a new solar estimate request
post
Update an existing solar estimate request
patch
Get an existing solar estimate request by ID
get
Get events for an existing solar estimate request by ID
get
Get event for an existing solar estimate request by ID and event ID
get
Webhooks
Get webhook subscriptions
get
Create a new webhook subscription
post
Delete a webhook subscription
del
/api/v1/webhooks/retry/{outboxId}
post
Powered by
Checklists
Ask AI