Cintoo API v2.0.0

This article describes and lists all differences of Cintoo API v2 from Cintoo API v1. Most of the functionality of API v.1 is replicated in API v.2.

 

Permissions: users must have according permissions to access various resources in a Cintoo project. Consult articles corresponding to a resource to see which permissions are required.

 

Warning: some API v2 endpoints may still change.

New endpoints available exclusively for API v2:

 

List permissions - list available permissions

 

Remove users from an account - any account member can remove themselves; removing other users requires Account Owner, Administrator or Project Manager role

Update the account roles of a user

 

Get subscription - get subscription details

 

Create a role - create a custom role

Delete role

Update role

 

Invite users - invite users and groups to an account

 

Create group - create a group with a description and color code attributed

Delete group - delete a group from the account

Add users to a group - add a list of users to a group

Remove users from a group - remove a list of users from a group

 

Generate an Usage Report - for users with Administrator role. Described in Usage Reports.

 

Create Project

Delete Project

Update Project - update project details such as name, description etc.

Patch Project - update only provided fields

Get a signed URL for project cover file upload

Update cloud file as cover for project

Restore Project - restore a deleted project

List Spatial References - list official Spatial References from https://spatialreference.org/

 

Get Users member of a project - list users who are members of a project

Add members to a project

Bulk remove users and groups from project - remove a list of users and groups from the project

Remove user from project

Remove group from project

 

List work zones - list work zones in a project

Create a work zone - create a work zone in a project

Remove user from work zone - remove user's access to the work zone and all child work zones

Copy a work zone - create a copy of a work zone including all sub-work zones and files in them. Root work zone could be copied as well.

 

Update a file name - edit the name of a file

Delete a file - delete a specific file from the project (irreversible action!)

Update the position and/or rotation of a scan or a model - apply transformation to data

Delete files - bulk delete up to 50 files from the project (irreversible action!)

Download a blob - download a blob, via a redirection to pre-signed URL

Get pre-signed urls for multiple blobs

Get a signed urls for cloud file upload

Register cloud files on a workzone

List file formats - list supported file formats

 

List annotations in a project - list all annotations in a project

Create an annotation

Get annotation - get an annotation, optionally with comments and attachments

Update an annotation

Delete an annotation

Create a comment on an annotation

 

List share links

Create a share link

Get a share link - get details of a share link

Delete a share link

Update a share link

 

Get crops - list all crops related to a project

Create a crop

Get crop - obtain details about a crop

Update crop - update a crop, including moving to a new work zone

Delete crop

Get a signed URL for crop cover file upload

 

Get measurements - obtain all measurements in a project

 

Update multiple tag lists - update a list of tag lists

Delete multiple tag lists - remove several tag lists from the project

Object detection on a tag list - launch AI detection on a tag list

Add P&ID elements to a tag list - add P&IDs to a 2D tag list

List AI detection classes - preparatory step for AI detection, to choose the right class

 

Get tags - get tags from a tag list

Bulk operation on tags - bulk operation on tags from a tag list (create, update, delete)

Move tags between tag lists - move tags from different tag lists to a common tag list

 

Trigger Export to mesh job - launches an Export to mesh job

 

List integrations on the account

Create integration links on annotations

List integrations on the project

Create account integration with Konekt

Get an account integration with Konekt

Update an account integration with Konekt

Delete an account integration with Konekt

Connect an account integration with Konekt

Disconnect an account integration with Konekt

Get configuration of integration with Konekt on a Project

Create configuration of integration with Konekt on a Project

 

Update configuration of integration with Konekt on a Project

Delete the integration with Konekt on a Project

Get configuration of integration with Autodesk on a Project

Create configuration of integration with Autodesk on Project

Update configuration of the integration with Autodesk on Project

Delete the integration with Autodesk on Project

Get my connection to Autodesk

Disconnect me from Autodesk

Create or update Autodesk connection


The list is constantly updated as new API calls are developed.

 

A link to v2 documentation is available on to the current v1.1.0 API documentation page.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article