Developer hubs
Sign in
Request
Response
BIM 360 API
BIM 360 API
Version 1
Developer's Guide
Introduction
API Basics
Field Guide
Account Admin
Assets
Cost Management
Data Connector
Issues
Model Coordination
Model Sets
Clash Testing
Relationships
Parameters
Migration Guides
Issues v1 Migration Guide
Partner Program
Rate Limits and Quotas
APS Rate Limits and Quotas
Account Admin Rate Limits
Assets Rate Limits
Checklists Rate Limits
Cost Management Rate Limits
Data Connector Rate Limits
Document Management Rate Limits
Issues Rate Limits
Model Coordination Rate Limits
Relationships Rate Limits
Locations Rate Limits
How-to Guide
Getting Started
Get Access to a BIM 360 Account
Manage API Access to BIM 360 Docs
Retrieve BIM 360 Account and Project ID
Account Admin
Create a New Project
Create a New Company
Activate a Service
Assets
Retrieve BIM 360 Assets Data
Setup BIM 360 Assets Project Settings
Managing BIM 360 Assets
Checklists
Retrieve a Checklists Container ID
Retrieve a Checklists Section Signature
Cost Management
Retrieve Cost Container ID
Setup a Budget Code Template
Link a Budget to a Contract (deprecated)
Link Budgets to Contracts (new)
Update a Contract's Company
Create a Potential Change Order (PCO)
Open a Potential Change Order (PCO)
Directly Attach Local Files to a Cost Item (deprecated)
Directly Attach Local Files to a Cost Item (new)
Download a Document Generated from an SCO (deprecated)
Download a Document Generated from an SCO (new)
Update a PCO's Custom Attributes
Track Performance with Breakdowns
Track Aggregated Budget Performance
Update Existing Timesheets
Integrating Cost Management with External ERP Systems
Data Connector
Submit a Data Request
Find and Update a Data Request
Find a Job and Retrieve Its Data Extract
Document Management
Upload Files to Document Management
Download Files from Document Management
Export PDF Files from Document Management
Retrieve a User's Folder Permissions
Update a User's Folder Permissions
Update a Document's Custom Attribute Values
Issues V2 (new)
Retrieve Issues Container ID
Retrieve Issues (new)
Create Issues (new)
Attach BIM 360 Document Management Files to Issues (new)
Retrieve Issue Custom Attributes Mapped to an Issue Type (new)
Attach a local attachment to an Issue (new)
Locations
Retrieve Locations Container ID
Model Coordination
Working with Model Sets and Versions
Working with Clash Results
Document-related (Pushpin) Issues and RFIs (beta)
Render Document-related (Pushpin) Issues(V1) and RFIs in Your App
Render Document-related (Pushpin) Issues(V2) and RFIs in Your App
Create Document-related (Pushpin) Issues(V1) and RFIs in Your App
Create Document-related (Pushpin) Issues(V2) and RFIs in Your App
Relationships
Relationship Querying
Create Relationships
RFIs (beta)
Retrieve RFIs Container ID
RFIs transitions
Attach BIM 360 Document Management Files to RFIs
API Reference
HTTP Specification
Account Admin
Projects
POST projects
GET projects (legacy)
GET projects (new)
GET projects/:project_id (legacy)
GET projects/:project_id (new)
PATCH projects/:project_id
PATCH projects/:project_id/image
Companies
POST companies
POST companies/import
GET companies (legacy)
GET companies/:company_id
GET companies/search
GET projects/:project_id/companies
PATCH companies/:company_id
PATCH companies/:company_id/image
GET companies (new)
Account Users
POST users
POST users/import
GET users
GET users/:user_id
GET users/search
PATCH users/:user_id
Project Users
GET projects/:project_id/users (legacy)
GET projects/:projectId/users (new)
GET projects/:project_id/users/:users_id (legacy)
GET projects/:projectId/users/:userId (new)
POST projects/:project_id/users
POST projects/:project_id/users/import (v2)
PATCH projects/:project_id/users/user_id (v2)
Project Roles
GET projects/:project_id/industry_roles (v2)
Business Units
PUT business_units_structure
GET business_units_structure
Jobs
GET jobs/:job_id
Assets
Assets
POST assets:batch-create V2
POST assets:batch-get V2
GET assets V2
PATCH assets:batch-patch V2
POST assets:batch-delete V2
Categories
POST categories
POST categories:batch-get
GET categories
Status-Sets
POST status-step-sets
POST status-step-sets:batch-get
GET status-step-sets
POST category-status-step-sets/status-step-sets:batch-get
PUT categories/:categoryId/status-step-set/:statusStepSetId
Statuses
POST asset-statuses
POST asset-statuses:batch-get
GET asset-statuses
Custom-Attributes
POST custom-attributes
POST custom-attributes:batch-get
GET custom-attributes
PATCH custom-attributes/:customAttributeId
GET categories/:categoryId/custom-attributes
PUT categories/:categoryId/custom-attributes/:customAttributeId
Error-Codes
GET error-codes
GET error-codes/:errorCodeName
Relationships (deprecated)
POST assets/:assetId/relationships
POST categories/:categoryId/relationships
POST relationships:delete
Checklists
Instances
GET instances
GET instances/:id
Templates
GET templates
GET templates/:id
Cost Management
Actions
POST actions
GET actions
Attachments
GET attachments
POST attachments
POST attachments:batch-create
DELETE attachments/:attachmentId
POST attachment-folders
Attribute Definitions
GET properties
Attribute Values
POST property-values:batch-update
Budget Code Segment Values
GET segment-values
GET values
POST values
POST values:import
DELETE values/:valueId
PATCH values/:valueId
GET values/:valueId
Budget Code Segments
GET templates/:templateId/segments
POST segments
DELETE segments/:segmentId
PATCH segments/:segmentId
GET segments/:segmentId
Budget Code Templates
GET templates
Budgets
GET budgets
POST budgets
POST budgets:import
DELETE budgets/:budgetId
PATCH budgets/:budgetId
GET budgets/:budgetId
Budgets-contracts
POST budgets-contracts:link
Change Order and Cost Items
POST cost-items:attach
POST cost-items:detach
Change Orders
GET change-orders
GET change-orders/:changeOrder
POST change-orders/:changeOrder
GET change-orders/:changeOrder/:id
PATCH change-orders/:changeOrder/:id
DELETE change-orders/:changeOrder/:id
Contracts
DELETE contracts/:contractId
PATCH contracts/:contractId
GET contracts/:contractId
GET contracts
POST contracts
Cost Items
GET cost-items
POST cost-items
POST cost-items:batch-create
GET cost-items/:costItemId
PATCH cost-items/:costItemId
DELETE cost-items/:costItemId
Documents
GET documents
Expenses
GET expenses
POST expenses
DELETE expenses/:id
PATCH expenses/:id
GET expenses/:id
Expense Items
GET expenses/:expenseId/items
POST expenses/:expenseId/items
DELETE expenses/:expenseId/items/:id
PATCH expenses/:expenseId/items/:id
GET expenses/:expenseId/items/:id
Main Contracts
GET main-contracts
POST main-contracts
GET main-contracts/:id
PATCH main-contracts/:id
DELETE main-contracts/:id
Main Contract Items
GET main-contracts/:mainContractId/items
POST main-contracts/:mainContractId/items
GET main-contracts/:mainContractId/items/:id
PATCH main-contracts/:mainContractId/items/:id
DELETE main-contracts/:mainContractId/items/:id
Payments
GET payments
GET payments/:id
Payment Items
GET payment-items
Schedule Of Values
GET schedule-of-values
POST schedule-of-values
GET schedule-of-values/:id
PATCH schedule-of-values/:id
DELETE schedule-of-values/:id
Sub Cost Items
GET sub-cost-items
POST sub-cost-items
POST sub-cost-items:copy
PATCH sub-cost-items/:subCostItemsId
DELETE sub-cost-items/:subCostItemsId
Tax
GET taxes
Timesheet
GET time-sheets
POST time-sheets
GET time-sheets/:id
PATCH time-sheets/:id
DELETE time-sheets/:id
Performance Tracking Item
GET performance-tracking-items
POST performance-tracking-items
GET performance-tracking-items/:id
DELETE performance-tracking-items/:id
Performance Tracking Item Instance
GET performance-tracking-item-instances
POST performance-tracking-item-instances
GET performance-tracking-item-instances/:id
PATCH performance-tracking-item-instances/:id
DELETE performance-tracking-item-instances/:id
Data Connector
Requests
POST requests
GET requests
GET requests/:requestId
PATCH requests/:requestId
DELETE requests/:requestId
Jobs
GET requests/:requestId/jobs
GET jobs
GET jobs/:jobId
DELETE jobs/:jobId
Data
GET jobs/:jobId/data-listing
GET jobs/:jobId/data/:name
Document Management
Custom Attributes (beta)
POST versions:batch-get
GET custom-attribute-definitions
POST custom-attribute-definitions
POST custom-attributes:batch-update
Documents
POST projects/:project_id/versions/:version_id/exports
GET projects/:project_id/versions/:version_id/exports/:export_id
Naming Standards (beta)
GET naming-standards/:id
Permissions (beta)
POST projects/:project_id/folders/:folder_id/permissions:batch-create
POST projects/:project_id/folders/:folder_id/permissions:batch-update
POST projects/:project_id/folders/:folder_id/permissions:batch-delete
GET projects/:project_id/folders/:folder_id/permissions
Issues-V2 (new)
Issues Profile
GET users/me
Issue Types
GET issue-types
Issue Attribute Definitions
GET issue-attribute-definitions
Issue Attribute Mappings
GET issue-attribute-mappings
Issue Root Cause Categories
GET issue-root-cause-categories
Issues
GET issues
POST issues
GET issues/:issueId
PATCH issues/:issueId
Issue Comments
GET comments
POST comments
Issue Attachments
GET attachments
POST attachments
POST attachments/:attachmentId
Locations
Nodes
GET nodes
Model Coordination
Model Set
POST modelsets
GET modelsets
GET jobs/:jobId
GET modelsets/:modelSetId
PATCH modelsets/:modelSetId
POST modelsets/:modelSetId/issues
POST issues/viewcontext
GET modelsets/:modelSetId/jobs/:jobId
POST modelsets/:modelSetId/screenshots
GET modelsets/:modelSetId/screenshots/:screenShotId
Model Set: Versions
POST modelsets/:modelSetId/versions
GET modelsets/:modelSetId/versions
GET modelsets/:modelSetId/versions/latest
GET modelsets/:modelSetId/versions/:version
PATCH modelsets/:modelSetId/versions:enable
PATCH modelsets/:modelSetId/versions:disable
Model Set: Views
POST modelsets/:modelSetId/views
GET modelsets/:modelSetId/views
POST modelsets/:modelSetId/views:lineages (deprecated)
GET modelsets/:modelSetId/views/:viewId
PATCH modelsets/:modelSetId/views/:viewId
DELETE modelsets/:modelSetId/views/:viewId
GET modelsets/:modelSetId/versions/:version/views
GET modelsets/:modelSetId/versions/:version/views/:viewId
GET modelsets/:modelSetId/views/:viewId/jobs/:jobId
Clash Test
GET modelsets/:modelSetId/tests
GET modelsets/:modelSetId/versions/:version/tests
GET tests/:testId
GET tests/:testId/resources
Clash Test: Closed Clash Groups
POST tests/:testId/clashes:close
GET tests/:testId/clashes/closed
POST tests/:testId/clashes/closed
POST modelsets/:modelSetId/clashes:reopen
GET modelsets/:modelSetId/clashes/closed
Clash Test: Assigned Clash Groups
POST tests/:testId/clashes:assign
GET tests/:testId/clashes/assigned
POST tests/:testId/clashes/assigned
GET modelsets/:modelSetId/clashes/assigned
GET clashes/assigned/viewcontext
Clash Test: Clash Groups Shared
GET clashes/jobs/:jobId
POST modelsets/:modelSetId/screenshots
GET modelsets/:modelSetId/screenshots/:screenShotId
GET modelsets/:modelSetId/clashes/grouped
Model Properties
Index
GET indexes/:indexId/fields
GET indexes/:indexId/manifest
GET indexes/:indexId/properties
GET indexes/:indexId/queries/:queryId
GET indexes/:indexId/queries/:queryId/properties
GET indexes/:indexId
POST indexes:batchStatus
POST indexes/:indexId/queries
Diff
GET diffs/:diffId/fields
GET diffs/:diffId/manifest
GET diffs/:diffId/properties
GET diffs/:diffId/queries/:queryId
GET diffs/:diffId/queries/:queryId/properties
GET diffs/:diffId
POST diffs:batchStatus
POST diffs/:diffId/queries
Relationships
Relationship: Utilities
GET utility/relationships:writable
Relationship: Modify
PUT relationships
POST relationships:delete
Relationship: Sync
POST relationships:syncStatus
POST relationships:sync
Relationship: Search
POST relationships:batch
GET relationships:search
POST relationships:intersect
GET relationships/:relationshipId
RFIs (beta)
RFIs
GET rfis
GET rfis/:id
POST rfis
GET users/me
PATCH rfis/:id
Comments
GET comments
POST comments
Attachments
GET attachments
POST attachments
DELETE attachments/:attachmentId
Change History
Account Admin V2 Changelog
Account Admin V1 Changelog
Assets Changelog
Checklists V1 Changelog
Cost Management V1 Changelog
Data Connector V1 Changelog
Document Management V1 Changelog
Issues V1 Changelog (deprecated)
Issues V2 Changelog (new)
Model Coordination Changelog
Relationships V2 Changelog
RFIs V1 Changelog