Jump to Content
Home
Guides
API Reference
YouTube
Home
Guides
API Reference
Home
Guides
API Reference
YouTube
API Reference
API Reference
Add many projects to folder
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
HTTP Response Codes
Trying the API
Zapier Overview
Supported Integrations
Hardware - Racking Integratations
Scanifly API
Users
Folders
Company
Module Library
Checklist
Checklist Template
Service Requests
Settings and preferences
Designs
Projects
Media
Media Categories
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
delete
Folders
Delete many projects from folder
delete
Add many projects to folder
patch
Add project to folder
post
Delete project from folder
delete
Create a folder
post
Get all company folders
get
Get folder
get
Update folder
patch
Delete folder
delete
Company
Get current users company
get
Get current users company members
get
Update company media categories
patch
Delete company media category
delete
Create company media category
post
Update company
patch
Update company image
post
Module Library
Read users module library
get
Update a users module library
put
Read company module library
get
Checklist
Create a new checklist
post
Get checklists by project id
get
Get checklist by id
get
Update checklist by id
put
Remove missing media
delete
Set checklist status by id
put
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
delete
Import a template
post
Service Requests
Settings and preferences
/api/v1/settings/simulation
post
Get simulation-settings by company
get
/api/v1/settings/simulation/{settingsId}
get
/api/v1/settings/simulation/{settingsId}
patch
/api/v1/settings/simulation/{settingsId}
delete
/api/v1/settings/shade
get
/api/v1/settings/shade
patch
/api/v1/settings/racking-preset/{rackingType}
get
/api/v1/settings/design-preset
get
/api/v1/settings/design-preset
patch
/api/v1/settings/racking-presets
get
/api/v1/settings/racking-preset
post
/api/v1/settings/racking-preset
patch
/api/v1/settings/setback-defaults
get
/api/v1/settings/setback-defaults
patch
/api/v1/settings/viewer-config
get
/api/v1/settings/viewer-config
patch
/api/v1/settings/input-mapping
get
/api/v1/settings/input-mapping
patch
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
delete
Duplicate design on project id
post
Projects
Get project by id
get
Update project
patch
Create project
post
List projects
get
Media
Get Media by Category id
get
Get Media by id
get
Media Categories
Get Media Categories for a project
get
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
delete
/api/v1/webhooks/retry/{outboxId}
post
Service Requests
Service Requests
Create service request
post
Get all existing service requests of a project
get
Create design services statistics data for scanifly admins
get
Powered by
Add many projects to folder
patch
https://api.portal.scanifly.com/api/v1/folders/
{id}
/projects/many
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!