Jump to Content
Home
Documentation
API Reference
Discussions
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
Documentation
API Reference
Discussions
Create Crew
Search
JUMP TO
Getting Started
Using Try It!
Logging in
Vitruvi API Documentation
Aggregation
/api/v1/aggregation/design_elements_files
get
/api/v1/aggregation/mobile_filter_options
get
/api/v1/aggregation/work_items_files
get
Ai agent
List Ai Agent Entity Logs
get
Create Ai Agent Entity Log
post
Retrieve Ai Agent Entity Log
get
Update Ai Agent Entity Log
put
Partial Update Ai Agent Entity Log
patch
Delete Ai Agent Entity Log
delete
List Agent Logs
get
Create Agent Log
post
Retrieve Agent Log
get
Update Agent Log
put
Partial Update Agent Log
patch
Delete Agent Log
delete
Async events
List Custom Action Categories
get
Retrieve Custom Action Category
get
List Custom Actions
get
Retrieve Custom Action
get
Execute (Custom Action)
post
List Event Hooks
get
Create Event Hook
post
Retrieve Event Hook
get
Update Event Hook
put
Partial Update Event Hook
patch
Delete Event Hook
delete
List Scripts
get
Create Script
post
Retrieve Script
get
Update Script
put
Partial Update Script
patch
Delete Script
delete
Global Configuration
List Companies
get
Create Company
post
Retrieve Company
get
Update Company
put
Partial Update Company
patch
Delete Company
delete
Get Company Logo
get
List Materials
get
Create Material
post
Get Material
get
Update Material
put
Patch Material
patch
Delete Material
delete
Batch Delete Material
post
Batch Update Material
post
List Companies
get
Create Company
post
Retrieve Company
get
Update Company
put
Partial Update Company
patch
Delete Company
delete
Get Company Logo
get
Conditional custom field overrides
List Conditional Custom Field Overrides
get
Create Conditional Custom Field Override
post
Retrieve Conditional Custom Field Override
get
Update Conditional Custom Field Override
put
Partial Update Conditional Custom Field Override
patch
Delete Conditional Custom Field Override
delete
Batch Delete Api (Conditional Custom Field Override)
post
Batch Update Api (Conditional Custom Field Override)
post
Configuration library
List Configuration Imports
get
Create Configuration Import
post
Retrieve Configuration Import
get
Update Configuration Import
put
Partial Update Configuration Import
patch
Delete Configuration Import
delete
/api/v1/configuration_library/export_program/{id}
get
/api/v1/configuration_library/import_program
post
Content types
List Content Types
get
Crew categories
List Crew Categories
get
Create Crew Category
post
Retrieve Crew Category
get
Update Crew Category
put
Partial Update Crew Category
patch
Delete Crew Category
delete
Crews
List Crews
get
Create Crew
post
Retrieve Crew
get
Update Crew
put
Partial Update Crew
patch
Delete Crew
delete
Crews with resources
List Crews
get
Create Crew
post
Retrieve Crew
get
Update Crew
put
Partial Update Crew
patch
Delete Crew
delete
Custom field categories
List Custom Field Categories
get
Create Custom Field Category
post
Retrieve Custom Field Category
get
Update Custom Field Category
put
Partial Update Custom Field Category
patch
Delete Custom Field Category
delete
Custom field settings
List Custom Field Settings
get
Create Custom Field Settings
post
Retrieve Custom Field Settings
get
Update Custom Field Settings
put
Partial Update Custom Field Settings
patch
Delete Custom Field Settings
delete
Batch Delete Api (Custom Field Settings)
post
Batch Update Api (Custom Field Settings)
post
Provisioning Schema (Custom Field Settings)
get
Custom field settings by entity
/api/v1/custom_field_settings_by_entity
get
Custom fields
List Custom Fields
get
Create Custom Field
post
Retrieve Custom Field
get
Update Custom Field
put
Partial Update Custom Field
patch
Delete Custom Field
delete
Data resource
List Data Resources
get
Create Data Resource
post
Retrieve Data Resource
get
Update Data Resource
put
Partial Update Data Resource
patch
Delete Data Resource
delete
Design element categories
List Design Element Categories
get
Create Design Element Category
post
Retrieve Design Element Category
get
Update Design Element Category
put
Partial Update Design Element Category
patch
Delete Design Element Category
delete
Engineering
/api/v1/engineering/archive
post
/api/v1/engineering/design_element_related_objects
get
List Design Elements
get
Create Design Element
post
Retrieve Design Element
get
Update Design Element
put
Partial Update Design Element
patch
Delete Design Element
delete
/api/v1/engineering/design_elements_categories_from_file
get
Get (Design Element)
get
List Design Elements
get
Create Design Element
post
Retrieve Design Element
get
Update Design Element
put
Partial Update Design Element
patch
Delete Design Element
delete
List Design Elements
get
Create Design Element
post
Retrieve Design Element
get
Update Design Element
put
Partial Update Design Element
patch
Delete Design Element
delete
/api/v1/engineering/design_elements_work_items/{id}/can_be_deleted/
get
Batch Delete Api (Design Element)
post
Batch Update Api (Design Element)
post
List Designs
get
Create Design
post
Retrieve Design
get
Update Design
put
Partial Update Design
patch
Delete Design
delete
Async Detail (Design)
put
Async Detail (Design)
patch
Async Detail (Design)
delete
Can Be Deleted (Design)
get
Async List (Design)
post
/api/v1/engineering/export_to_geojson/
get
/api/v1/engineering/extent_view
get
/api/v1/engineering/external_integration
get
/api/v1/engineering/external_integration
post
/api/v1/engineering/geometry_length
get
List Markup Custom Field Visibilities
get
Create Markup Item Custom Field Visibility
post
Retrieve Markup Item Custom Field Visibility
get
Update Markup Item Custom Field Visibility
put
Partial Update Markup Item Custom Field Visibility
patch
Delete Markup Item Custom Field Visibility
delete
Import GeoJson
post
/api/v1/engineering/process_job/{id}
get
/api/v1/engineering/process_results
get
List Config Files
get
Create Config File
post
Retrieve Config File
get
Update Config File
put
Partial Update Config File
patch
Delete Config File
delete
List Processes
get
Create Process
post
Retrieve Process
get
Update Process
put
Partial Update Process
patch
Delete Process
delete
Async Detail (Process)
put
Async Detail (Process)
patch
Async Detail (Process)
delete
Can Be Deleted (Process)
get
Geom Types (Process)
get
Not Null Field Values By De Type (Process)
get
Regions (Process)
get
Unique Field Values (Process)
get
Async List (Process)
post
/api/v1/engineering/start_process/{id}
post
/api/v1/engineering/validate_process/{id}
post
Delete Design Elements
post
Generate GeoJson Template
get
Import GeoJson
post
List Design Elements
get
Update Design Elements
post
Validate GeoJson Template
post
Entity file folders
List Entity File Folders
get
Create Entity File Folder
post
Update Entity File Folder
put
Partial Update Entity File Folder
patch
Entity files
List Entity Files
get
Create Entity File
post
Retrieve Entity File
get
Update Entity File
put
Partial Update Entity File
patch
Delete Entity File
delete
Download (Entity File)
get
Batch Delete Api (Entity File)
post
Batch Update Api (Entity File)
post
Delete (Entity File)
delete
Download (Entity File)
get
Linked Folder (Entity File)
get
Zipped Files (Entity File)
post
Equipment
List Equipment
get
Create Equipment
post
Retrieve Equipment
get
Update Equipment
put
Partial Update Equipment
patch
Delete Equipment
delete
Equipment categories
List Equipment Categories
get
Create Equipment Category
post
Retrieve Equipment Category
get
Update Equipment Category
put
Partial Update Equipment Category
patch
Delete Equipment Category
delete
Exports
/api/v1/exports/
get
/api/v1/exports/
post
/api/v1/exports/{id}/
get
/api/v1/exports/{id}/
delete
/api/v1/exports/{id}/cancel/
patch
/api/v1/exports/{id}/rerun/
post
/api/v1/exports/grid
post
/api/v1/exports/schedules/
get
/api/v1/exports/schedules/
post
/api/v1/exports/schedules/{id}/
get
/api/v1/exports/schedules/{id}/
put
/api/v1/exports/schedules/{id}/
patch
/api/v1/exports/schedules/{id}/
delete
List Export Templates
get
Create Export Template
post
Retrieve Export Template
get
Update Export Template
put
Partial Update Export Template
patch
Delete Export Template
delete
Global settings
List Settings
get
Create Setting
post
Retrieve Setting
get
Update Setting
put
Partial Update Setting
patch
Delete Setting
delete
Grid views
List Grid Views
get
Create Grid View
post
Retrieve Grid View
get
Update Grid View
put
Partial Update Grid View
patch
Delete Grid View
delete
Share (Grid View)
post
Inbox
/api/v1/inbox/feature_batches/mark_processed
post
/api/v1/inbox/feature_batches/to_process
get
Infrastructure categories
List Infrastructure Categories
get
Create Infrastructure Category
post
Retrieve Infrastructure Category
get
Update Infrastructure Category
put
Partial Update Infrastructure Category
patch
Delete Infrastructure Category
delete
Integrations
/api/v1/integrations/{integration_name}
get
/api/v1/integrations/{integration_name}
post
Invoicing
List Deliverable Payable Item Templates
get
Create Deliverable Payable Item Template
post
Retrieve Deliverable Payable Item Template
get
Update Deliverable Payable Item Template
put
Partial Update Deliverable Payable Item Template
patch
Batch Delete Api (Deliverable Payable Item Template)
post
Batch Update Api (Deliverable Payable Item Template)
post
List Work Items
get
Update Work Item
put
Partial Update Work Item
patch
List Invoice Items
get
Retrieve Invoice Item
get
Update Invoice Item
put
Partial Update Invoice Item
patch
Batch Delete Api (Invoice Item)
post
Batch Update Api (Invoice Item)
post
List Invoices
get
Create Invoice
post
Retrieve Invoice
get
Update Invoice
put
Partial Update Invoice
patch
Delete Invoice
delete
Aggregated Items (Invoice)
get
Detailed Items (Invoice)
get
Single Pdf (Invoice)
get
Batch Delete Api (Invoice)
post
Batch Update Api (Invoice)
post
Multi Pdf (Invoice)
get
List Labor Material Payable Item Templates
get
Create Labor Material Payable Item Template
post
Retrieve Labor Material Payable Item Template
get
Update Labor Material Payable Item Template
put
Partial Update Labor Material Payable Item Template
patch
Batch Delete Api (Labor Material Payable Item Template)
post
Batch Update Api (Labor Material Payable Item Template)
post
List Pricing Rule Sets
get
Create Pricing Rule Set
post
Retrieve Pricing Rule Set
get
Update Pricing Rule Set
put
Partial Update Pricing Rule Set
patch
Delete Pricing Rule Set
delete
List Progress Payable Items
get
Create Progress Payable Item
post
Retrieve Progress Payable Item
get
Update Progress Payable Item
put
Partial Update Progress Payable Item
patch
Delete Progress Payable Item
delete
Batch Delete Api (Progress Payable Item)
post
Batch Update Api (Progress Payable Item)
post
List Purchase Orders
get
Create Purchase Order
post
Retrieve Purchase Order
get
Update Purchase Order
put
Partial Update Purchase Order
patch
Delete Purchase Order
delete
Batch Delete Api (Purchase Order)
post
Batch Update Api (Purchase Order)
post
List Region Tax Codes
get
Create Region Tax Code
post
Retrieve Region Tax Code
get
Update Region Tax Code
put
Partial Update Region Tax Code
patch
Delete Region Tax Code
delete
List Subcontract Payable Item Templates
get
Create Subcontract Payable Item Template
post
Retrieve Subcontract Payable Item Template
get
Update Subcontract Payable Item Template
put
Partial Update Subcontract Payable Item Template
patch
Delete Subcontract Payable Item Template
delete
Batch Delete Api (Subcontract Payable Item Template)
post
Batch Update Api (Subcontract Payable Item Template)
post
List Tax Codes
get
Create Tax Code
post
Retrieve Tax Code
get
Update Tax Code
put
Partial Update Tax Code
patch
Delete Tax Code
delete
Jobs
Get Job Status
get
Labor items
List Quantity Descriptions
get
Create Quantity Description
post
Retrieve Quantity Description
get
Update Quantity Description
put
Partial Update Quantity Description
patch
Delete Quantity Description
delete
Material categories
List Material Categories
get
Create Material Category
post
Retrieve Material Category
get
Update Material Category
put
Partial Update Material Category
patch
Delete Material Category
delete
Batch Delete Api (Material Category)
post
Batch Update Api (Material Category)
post
Material quantity descriptions
List Quantity Descriptions
get
Create Quantity Description
post
Retrieve Quantity Description
get
Update Quantity Description
put
Partial Update Quantity Description
patch
Delete Quantity Description
delete
Mobile
List Crews
get
Create Crew
post
Retrieve Crew
get
Update Crew
put
Partial Update Crew
patch
Delete Crew
delete
/api/v1/mobile/devices/
post
/api/v1/mobile/devices/
put
/api/v1/mobile/devices/
patch
/api/v1/mobile/devices/
delete
List Equipment
get
Create Equipment
post
Retrieve Equipment
get
Update Equipment
put
Partial Update Equipment
patch
Delete Equipment
delete
List Extra Work Order Requests
get
Create Extra Work Order Request
post
Retrieve Extra Work Order Request
get
Update Extra Work Order Request
put
Partial Update Extra Work Order Request
patch
Delete Extra Work Order Request
delete
List Materials
get
Retrieve Material
get
/api/v1/mobile/production_log
post
List Production Reports
get
Create Production Report
post
Retrieve Production Report
get
Update Production Report
put
Partial Update Production Report
patch
Delete Production Report
delete
List Mobile Draft Production Reports Backup
get
Create Mobile Draft Production Report Backup
post
Retrieve Mobile Draft Production Report Backup
get
Update Mobile Draft Production Report Backup
put
Partial Update Mobile Draft Production Report Backup
patch
Delete Mobile Draft Production Report Backup
delete
/api/v1/mobile/production_reports_job
post
List Timesheets
get
Create Timesheet
post
Retrieve Timesheet
get
Update Timesheet
put
Partial Update Timesheet
patch
Delete Timesheet
delete
List Work Items
get
Create Work Item
post
Retrieve Work Item
get
Update Work Item
put
Partial Update Work Item
patch
Delete Work Item
delete
Monitoring
/api/v1/monitoring/heartbeat
get
/api/v1/monitoring/migrations
get
/api/v1/monitoring/version
get
Network calculus
/api/v1/network_calculus/external_integration
get
/api/v1/network_calculus/external_integration
post
Network operator
List Element Categories
get
Create Element Category
post
Retrieve Element Category
get
Update Element Category
put
Partial Update Element Category
patch
Delete Element Category
delete
Batch Delete Api (Element Category)
post
Batch Update Api (Element Category)
post
List Infrastructure Categories
get
Create Infrastructure Category
post
Retrieve Infrastructure Category
get
Update Infrastructure Category
put
Partial Update Infrastructure Category
patch
Delete Infrastructure Category
delete
List Labor Items
get
Create Labor Item
post
Retrieve Labor Item
get
Update Labor Item
put
Partial Update Labor Item
patch
Delete Labor Item
delete
Batch Delete Api (Labor Item)
post
Batch Update Api (Labor Item)
post
List Material Categories
get
Create Material Category
post
Retrieve Material Category
get
Update Material Category
put
Partial Update Material Category
patch
Delete Material Category
delete
Batch Delete Api (Material Category)
post
Batch Update Api (Material Category)
post
List Materials
get
Create Material
post
Retrieve Material
get
Update Material
put
Partial Update Material
patch
Delete Material
delete
Batch Delete Api (Material)
post
Batch Update Api (Material)
post
List Payable Item Categories
get
Create Payable Item Category
post
Retrieve Payable Item Category
get
Update Payable Item Category
put
Partial Update Payable Item Category
patch
Delete Payable Item Category
delete
List Premise Categories
get
Create Premise Category
post
Retrieve Premise Category
get
Update Premise Category
put
Partial Update Premise Category
patch
Delete Premise Category
delete
List Premises
get
Create Premise
post
Retrieve Premise
get
Update Premise
put
Partial Update Premise
patch
Delete Premise
delete
List Program Segments
get
Create Program Segment
post
Retrieve Program Segment
get
Update Program Segment
put
Partial Update Program Segment
patch
Delete Program Segment
delete
Regions (Program Segment)
get
List Program Standards
get
Create Program Standard
post
Retrieve Program Standard
get
Update Program Standard
put
Partial Update Program Standard
patch
Delete Program Standard
delete
Download (Program Standard)
get
List Programs
get
Create Program
post
Retrieve Program
get
Update Program
put
Partial Update Program
patch
Delete Program
delete
Has Associated Work Items (Program)
get
Regions (Program)
get
List Region Levels
get
Create Region Level
post
Retrieve Region Level
get
Update Region Level
put
Partial Update Region Level
patch
Delete Region Level
delete
List Regions
get
Create Region
post
Retrieve Region
get
Update Region
put
Partial Update Region
patch
Delete Region
delete
Children (Region)
get
Batch Delete Api (Region)
post
Batch Update Api (Region)
post
Centroid (Region)
get
Path (Region)
get
List Regions
get
Create Region
post
Retrieve Region
get
Update Region
put
Partial Update Region
patch
Delete Region
delete
List Work Order Categories
get
Create Work Order Category
post
Retrieve Work Order Category
get
Update Work Order Category
put
Partial Update Work Order Category
patch
Delete Work Order Category
delete
Network operators
List Companies
get
Create Company
post
Retrieve Company
get
Update Company
put
Partial Update Company
patch
Delete Company
delete
Regions (Company)
get
Payable item categories
List Payable Item Categories
get
Create Payable Item Category
post
Retrieve Payable Item Category
get
Update Payable Item Category
put
Partial Update Payable Item Category
patch
Delete Payable Item Category
delete
Permissions tree view
/api/v1/permissions_tree_view/{permission_for}/{permission_type}
get
/api/v1/permissions_tree_view/{permission_for}/{permission_type}
post
Permissions tree view compacted
/api/v1/permissions_tree_view_compacted/{permission_for}/{permission_type}
get
/api/v1/permissions_tree_view_compacted/{permission_for}/{permission_type}
post
Premise categories
List Premise Categories
get
Create Premise Category
post
Retrieve Premise Category
get
Update Premise Category
put
Partial Update Premise Category
patch
Delete Premise Category
delete
Presigned urls
/api/v1/presigned_urls/
get
Production
List Production Report Custom Field Visibilities
get
Create Production Report Custom Field Visibility
post
Retrieve Production Report Custom Field Visibility
get
Update Production Report Custom Field Visibility
put
Partial Update Production Report Custom Field Visibility
patch
Delete Production Report Custom Field Visibility
delete
Bulk (Production Report Custom Field Visibility)
post
Bulk Compacted (Production Report Custom Field Visibility)
post
/api/v1/production/custom_fields
get
List Extra Work Order Requests
get
Create Extra Work Order Request
post
Retrieve Extra Work Order Request
get
Update Extra Work Order Request
put
Partial Update Extra Work Order Request
patch
Delete Extra Work Order Request
delete
List Production Report Header Custom Field Visibilities
get
Create Production Report Header Custom Field Visibility
post
Retrieve Production Report Header Custom Field Visibility
get
Update Production Report Header Custom Field Visibility
put
Partial Update Production Report Header Custom Field Visibility
patch
Delete Production Report Header Custom Field Visibility
delete
List Production Report Quantities
get
Create Production Report Quantity
post
Retrieve Production Report Quantity
get
Update Production Report Quantity
put
Partial Update Production Report Quantity
patch
Delete Production Report Quantity
delete
List Production Report Items
get
Create Production Report Item
post
Retrieve Production Report Item
get
Update Production Report Item
put
Partial Update Production Report Item
patch
Delete Production Report Item
delete
Batch Delete Api (Production Report Item)
post
Batch Update Api (Production Report Item)
post
List Production Report Locations
get
Create Production Report Location
post
Retrieve Production Report Location
get
Update Production Report Location
put
Partial Update Production Report Location
patch
Delete Production Report Location
delete
List Production Report Quantities
get
Create Production Report Quantity
post
Retrieve Production Report Quantity
get
Update Production Report Quantity
put
Partial Update Production Report Quantity
patch
Delete Production Report Quantity
delete
List Production Reports
get
Create Production Report
post
List Comments
get
Create Comment
post
Retrieve Comment
get
Retrieve Production Report
get
Update Production Report
put
Partial Update Production Report
patch
Delete Production Report
delete
Pdf (Production Report)
get
Batch Delete Api (Production Report)
post
Batch Update Api (Production Report)
post
List Production Report Design Element Markups
get
Create Production Report Design Element Markup
post
Retrieve Production Report Design Element Markup
get
Update Production Report Design Element Markup
put
Partial Update Production Report Design Element Markup
patch
Delete Production Report Design Element Markup
delete
Push notifications
/api/v1/push_notifications/devices/
post
/api/v1/push_notifications/devices/
delete
Qualifications
List Qualifications
get
Create Qualification
post
Retrieve Qualification
get
Update Qualification
put
Partial Update Qualification
patch
Delete Qualification
delete
Quantity descriptions
List Quantity Descriptions
get
Create Quantity Description
post
Retrieve Quantity Description
get
Update Quantity Description
put
Partial Update Quantity Description
patch
Delete Quantity Description
delete
Reporting
Get Raw Model Data
get
Get Raw Model Data
get
Get Raw Model List
get
Export Accounts Payable Items
get
Export Accounts Receivable Items
get
Export Crew Members
get
Export Crews
get
Export Custom Field Settings
get
Export Design Elements
get
Export Designs
get
Extra Work Item Quantity Request Grid View
get
Design Elements Grid View
get
Export Invoices
get
Export Production Report Lines
get
Export Production Report Quantities
get
Export Production Reports
get
Export Profiles
get
Export Regions
get
Invoice Items Grid View
get
Export Scopes
get
Tickets Grid View
get
Export Tickets
get
Export Work Item Quantities
get
Export Work Items
get
Export Work Orders
get
Export Work Packages
get
Timesheet Lines Grid View
get
Design Elements Work Items Grid View
get
Production Report Grid Grid View
get
Invoices Grid View
get
Timesheets Grid View
get
Limited Design Elements Grid View
get
Work Item Quantities Grid View
get
Production Reports Grid View
get
Work Items Grid View
get
Work Orders Grid View
get
Work Packages Grid View
get
Revision changesets
/api/v1/revision_changesets/{id}/
get
Roles
List Roles
get
Create Role
post
Retrieve Role
get
Update Role
put
Partial Update Role
patch
Delete Role
delete
Safety
List Hazard Requirement Assessments
get
Create Hazard Requirement Assessment
post
Retrieve Hazard Requirement Assessment
get
Update Hazard Requirement Assessment
put
Partial Update Hazard Requirement Assessment
patch
Delete Hazard Requirement Assessment
delete
List Field Level Hazard Assessments
get
Create Field Level Hazard Assessment
post
Retrieve Field Level Hazard Assessment
get
Update Field Level Hazard Assessment
put
Partial Update Field Level Hazard Assessment
patch
Delete Field Level Hazard Assessment
delete
List Field Level Work Steps
get
Create Field Level Work Step
post
Retrieve Field Level Work Step
get
Update Field Level Work Step
put
Partial Update Field Level Work Step
patch
Delete Field Level Work Step
delete
List Field Level Hazards
get
Create Field Level Hazard
post
Retrieve Field Level Hazard
get
Update Field Level Hazard
put
Partial Update Field Level Hazard
patch
Delete Field Level Hazard
delete
List Work Steps
get
Create Work Step
post
Retrieve Work Step
get
Update Work Step
put
Partial Update Work Step
patch
Delete Work Step
delete
List Critical Requirements Files
get
Create Critical Requirements File
post
Retrieve Critical Requirements File
get
Update Critical Requirements File
put
Partial Update Critical Requirements File
patch
Delete Critical Requirements File
delete
List Hazard Requirements
get
Create Hazard Requirement
post
Retrieve Hazard Requirement
get
Update Hazard Requirement
put
Partial Update Hazard Requirement
patch
Delete Hazard Requirement
delete
/api/v1/safety/safety_package
get
List Hazards
get
Create Hazard
post
Retrieve Hazard
get
Update Hazard
put
Partial Update Hazard
patch
Delete Hazard
delete
List Field Level Hazard Assessment Signatures
get
Create Field Level Hazard Assessment Signature
post
Retrieve Field Level Hazard Assessment Signature
get
Update Field Level Hazard Assessment Signature
put
Partial Update Field Level Hazard Assessment Signature
patch
Delete Field Level Hazard Assessment Signature
delete
Scheduling
/api/v1/scheduling/ai_scheduling
post
List Draft Schedules
get
Retrieve Draft Schedule
get
Update Draft Schedule
put
Partial Update Draft Schedule
patch
Apply (Draft Schedule)
post
/api/v1/scheduling/schedule_dependencies_by_item
get
Delete Schedule Item Dependency
delete
Batch Delete Api (Schedule Item Dependency)
post
Batch Update Api (Schedule Item Dependency)
post
/api/v1/scheduling/schedule_items
get
/api/v1/scheduling/schedule_items
patch
/api/v1/scheduling/schedule_unrestricted
get
/api/v1/scheduling/schedule_work_package/{id}
post
/api/v1/scheduling/task_dependencies/
get
/api/v1/scheduling/task_dependencies/
post
/api/v1/scheduling/task_dependencies/{id}/
get
/api/v1/scheduling/task_dependencies/{id}/
put
/api/v1/scheduling/task_dependencies/{id}/
patch
/api/v1/scheduling/task_dependencies/{id}/
delete
List Tasks
get
Create Task
post
Retrieve Task
get
Update Task
put
Partial Update Task
patch
Delete Task
delete
/api/v1/scheduling/task_template_dependencies/
get
/api/v1/scheduling/task_template_dependencies/
post
/api/v1/scheduling/task_template_dependencies/{id}/
get
/api/v1/scheduling/task_template_dependencies/{id}/
put
/api/v1/scheduling/task_template_dependencies/{id}/
patch
/api/v1/scheduling/task_template_dependencies/{id}/
delete
/api/v1/scheduling/task_templates/
get
/api/v1/scheduling/task_templates/
post
/api/v1/scheduling/task_templates/{id}/
get
/api/v1/scheduling/task_templates/{id}/
put
/api/v1/scheduling/task_templates/{id}/
patch
/api/v1/scheduling/task_templates/{id}/
delete
List Work Orders
get
Create Work Order
post
Retrieve Work Order
get
Update Work Order
put
Partial Update Work Order
patch
Delete Work Order
delete
Settings
/api/v1/settings/
get
Subscribe
/api/v1/subscribe
post
Support utils
/api/v1/support_utils/{command_name}
post
Ticketing
List Ticket Custom Field Visibilities
get
Create Ticket Custom Field Visibility
post
Retrieve Ticket Custom Field Visibility
get
Update Ticket Custom Field Visibility
put
Partial Update Ticket Custom Field Visibility
patch
Delete Ticket Custom Field Visibility
delete
List Ticket Actions
get
Retrieve Ticket Action
get
List Ticket Collections
get
List Tickets
get
Create Ticket
post
Retrieve Ticket
get
Update Ticket
put
Partial Update Ticket
patch
Delete Ticket
delete
Download Attachment (Ticket)
get
Time keeping
List Timesheet Custom Field Visibilities
get
Create Timesheet Custom Field Visibility
post
Retrieve Timesheet Custom Field Visibility
get
Update Timesheet Custom Field Visibility
put
Partial Update Timesheet Custom Field Visibility
patch
Delete Timesheet Custom Field Visibility
delete
List Shifts
get
Create Shift
post
Retrieve Shift
get
Update Shift
put
Partial Update Shift
patch
Delete Shift
delete
/api/v1/time_keeping/timesheet_acknowledgments/
get
/api/v1/time_keeping/timesheet_acknowledgments/
post
/api/v1/time_keeping/timesheet_acknowledgments/{id}/
get
/api/v1/time_keeping/timesheet_acknowledgments/{id}/
delete
List Timesheet Lines
get
Create Timesheet Line
post
Retrieve Timesheet Line
get
Update Timesheet Line
put
Partial Update Timesheet Line
patch
Delete Timesheet Line
delete
List Timesheets
get
Create Timesheet
post
Retrieve Timesheet
get
Update Timesheet
put
Partial Update Timesheet
patch
Delete Timesheet
delete
Unique field check
/api/v1/unique_field_check/{contentType}/
get
Unit dimensions
List Unit Dimensions
get
Create Unit Dimension
post
Retrieve Unit Dimension
get
Update Unit Dimension
put
Partial Update Unit Dimension
patch
Delete Unit Dimension
delete
Units
List Units
get
Create Unit
post
Retrieve Unit
get
Update Unit
put
Partial Update Unit
patch
Delete Unit
delete
Unsubscribe
/api/v1/unsubscribe
post
User groups
List Groups
get
Create Group
post
Retrieve Group
get
Update Group
put
Partial Update Group
patch
Delete Group
delete
User permissions
List Permissions
get
Retrieve Permission
get
User tiers
List User Tier Changes
get
Create User Tier Change
post
Retrieve User Tier Change
get
Update User Tier Change
put
Partial Update User Tier Change
patch
Delete User Tier Change
delete
Users
List Profiles
get
Create Profile
post
Retrieve Profile
get
Update Profile
put
Partial Update Profile
patch
Delete Profile
delete
Avatar (Profile)
put
Download Avatar (Profile)
get
Batch Delete Api (Profile)
post
Batch Update Api (Profile)
post
Variables
List Variables
get
Create Variable
post
Retrieve Variable
get
Update Variable
put
Partial Update Variable
patch
Delete Variable
delete
Async Detail (Variable)
put
Async Detail (Variable)
patch
Async Detail (Variable)
delete
Async List (Variable)
post
Batch Delete Api (Variable)
post
Batch Update Api (Variable)
post
Wbs
/api/v1/wbs/design_elements_work_status/
get
/api/v1/wbs/design_elements_work_status/definitions/
get
List Element Work Templates
get
Create Element Work Template
post
Retrieve Element Work Template
get
Update Element Work Template
put
Partial Update Element Work Template
patch
Delete Element Work Template
delete
Clone From Library (Element Work Template)
post
/api/v1/wbs/estimations_export/
get
List Library Element Work Templates
get
Create Library Element Work Template
post
Retrieve Library Element Work Template
get
Update Library Element Work Template
put
Partial Update Library Element Work Template
patch
Delete Library Element Work Template
delete
List Library Work Item Templates
get
Create Library Work Item Template
post
Retrieve Library Work Item Template
get
Update Library Work Item Template
put
Partial Update Library Work Item Template
patch
Delete Library Work Item Template
delete
List Library Work Order Templates
get
Create Library Work Order Template
post
Retrieve Library Work Order Template
get
Update Library Work Order Template
put
Partial Update Library Work Order Template
patch
Delete Library Work Order Template
delete
List Library Work Package Templates
get
Create Library Work Package Template
post
Retrieve Library Work Package Template
get
Update Library Work Package Template
put
Partial Update Library Work Package Template
patch
Delete Library Work Package Template
delete
/api/v1/wbs/material_forecast_categories
get
/api/v1/wbs/material_forecasts
get
List Material Requirements
get
Create Material Requirement
post
Retrieve Material Requirement
get
Update Material Requirement
put
Partial Update Material Requirement
patch
Delete Material Requirement
delete
List Subcontracts
get
Create Subcontract
post
Retrieve Subcontract
get
Update Subcontract
put
Partial Update Subcontract
patch
Delete Subcontract
delete
List Work Item Quantities
get
Create Work Item Quantity
post
Retrieve Work Item Quantity
get
Update Work Item Quantity
put
Partial Update Work Item Quantity
patch
Delete Work Item Quantity
delete
List Work Item Quantities
get
Create Work Item Quantity
post
Retrieve Work Item Quantity
get
Update Work Item Quantity
put
Partial Update Work Item Quantity
patch
Delete Work Item Quantity
delete
List Work Item Quantity Templates
get
Create Work Item Quantity Template
post
Retrieve Work Item Quantity Template
get
Update Work Item Quantity Template
put
Partial Update Work Item Quantity Template
patch
Delete Work Item Quantity Template
delete
Update Work Item
put
Partial Update Work Item
patch
Async Detail (Work Item)
put
Async Detail (Work Item)
patch
Async Detail (Work Item)
delete
Async List (Work Item)
post
List Work Item Templates
get
Create Work Item Template
post
Retrieve Work Item Template
get
Update Work Item Template
put
Partial Update Work Item Template
patch
Delete Work Item Template
delete
Clone From Library (Work Item Template)
post
List Work Items
get
Create Work Item
post
Retrieve Work Item
get
Update Work Item
put
Partial Update Work Item
patch
Delete Work Item
delete
Pdf (Work Item)
get
Photos (Work Item)
get
Batch Delete Api (Work Item)
post
Batch Update Api (Work Item)
post
Bulk Pdf (Work Item)
get
Next Unique Name (Work Item)
get
List Work Items
get
Retrieve Work Item
get
/api/v1/wbs/work_order_invoice_items/
get
/api/v1/wbs/work_order_purchase_orders/
get
Create Work Order
post
Update Work Order
put
Partial Update Work Order
patch
Async Detail (Work Order)
put
Async Detail (Work Order)
patch
Async Detail (Work Order)
delete
Async List (Work Order)
post
List Work Order Templates
get
Create Work Order Template
post
Retrieve Work Order Template
get
Update Work Order Template
put
Partial Update Work Order Template
patch
Delete Work Order Template
delete
Clone From Library (Work Order Template)
post
List Work Orders
get
Create Work Order
post
Retrieve Work Order
get
Update Work Order
put
Partial Update Work Order
patch
Delete Work Order
delete
Async Detail (Work Order)
put
Async Detail (Work Order)
patch
Async Detail (Work Order)
delete
Async List (Work Order)
post
Batch Delete Api (Work Order)
post
Batch Update Api (Work Order)
post
Work Order Categories (Work Order)
get
/api/v1/wbs/work_package_files/{id}
get
/api/v1/wbs/work_package_invoice_items/
get
/api/v1/wbs/work_package_tasks/
get
List Work Package Templates
get
Create Work Package Template
post
Retrieve Work Package Template
get
Update Work Package Template
put
Partial Update Work Package Template
patch
Delete Work Package Template
delete
Clone From Library (Work Package Template)
post
List Work Packages
get
Create Work Package
post
Retrieve Work Package
get
Update Work Package
put
Partial Update Work Package
patch
Delete Work Package
delete
Async Detail (Work Package)
put
Async Detail (Work Package)
patch
Async Detail (Work Package)
delete
Pdf (Work Package)
get
Async List (Work Package)
post
Batch Delete Api (Work Package)
post
Batch Update Api (Work Package)
post
Financials (Work Package)
get
/api/v1/wbs/workable_work_orders
get
/api/v1/wbs/workable_work_packages
get
Work item categories
List Work Item Categories
get
Create Work Item Category
post
Retrieve Work Item Category
get
Update Work Item Category
put
Partial Update Work Item Category
patch
Delete Work Item Category
delete
Work order categories
List Work Order Categories
get
Create Work Order Category
post
Retrieve Work Order Category
get
Update Work Order Category
put
Partial Update Work Order Category
patch
Delete Work Order Category
delete
Auth
List Permissions
get
Create Permission
post
Get Permission
get
Update Permission
put
Patch Permission
patch
Delete Permission
delete
List Security Groups
get
Create Security Group
post
Get Security Group
get
Update Security Group
put
Patch Security Group
patch
Delete Security Group
delete
Obtain JWT
post
Refresh JWT
post
Verify JWT
post
Get Current User Info
get
List Accounts
get
Create Account
post
Retrieve Account
get
Update Account
put
Partial Update Account
patch
Delete Account
delete
/auth/v1/workato_embedded_url
get
Powered by
Create Crew
post
https://{workspace}.api.vitruvi.cc/api/v1/mobile/crews/
Creates a new crew record.
Language
Shell
Node
Ruby
PHP
Python
Credentials
Basic
:
URL
Base URL
https://
demo
.api.vitruvi.cc
/api/v1/mobile/crews/
RESPONSE
Click
Try It!
to start a request and see the response here!