GET
groups/{groupID}/twins
Returns all twins for the given group.
Resource Information
| Method and URI | GET https://developer.api.autodesk.com/tandem/v1/groups/{groupID}/twins |
| Authentication Context | user context optional |
| Required OAuth Scopes | data:read |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is a two-legged access token obtained via a Client Credentials Grant flow, or a three-legged access token obtained via Authorization Code flow, Authorization Code flow with PKCE, or Secure Service Account flow (for headless scenarios). |
| Region string | Specifies the region where your request should be routed. Possible values: US, EMEA. For more details, see Regions. |
* Required
Request
URI Parameters
| groupID string | Group URN |
Response
HTTP Status Code Summary
| 200 OK | OK |
| 403 Forbidden | The request was successfully validated but it did not have the required permissions. |
| 500 Internal Server Error | The service encountered an error that it was unable to handle. Wait for a few minutes and resend the request. If the error persists, contact us at aps.help@autodesk.com. |
Response
Body Structure (200)
Expand all
object | |
| accessLevel int | Level of access to the corresponding resource. |
| accountGroup string | |
| accountType string | Account type |
| boundByUpperFloor boolean | Use overhead floor slab as upper bounds for room assignment |
| dateCreated string | Date of creation of the facility. |
| dateModified string | |
| docs array: object | List of documents linked to the facility. |
| accAccountId string | Optional account ID of Autodesk Docs where original document is stored |
| accLineage string | Optional item id of document |
| accProjectId string | Optional project ID of Autodesk Docs where original document is stored |
| accVersion string | Optional version of of document |
| contentType string | content type (i.e. application/pdf) |
| id string | Unique id of document |
| label string | Optional label |
| lastUpdated string | Optional timestamp of last modification (ISO 8601 format) |
| name string | Document name |
| s3Path string | S3 storage location |
| signedLink string | Optional signed URL |
| uploadPending boolean | Optional readability of a document |
| etag string | |
| links array: object | List of models linked to the facility. |
| accessLevel int | Level of access to the corresponding resource. |
| disciplines array: string | |
| label string | |
| main boolean | |
| modelId string | |
| on boolean | |
| props object | |
| Identity Data object | |
| Address string | |
| Building Name string | |
| Owner string | |
| Project Name string | |
| timeZone string | TimeZone IANA identifier from iana.org/time-zones |
| Other object | |
| Project Number string | |
| handover object | |
| receiverId string | |
| receiverName string | Cached details on the receiver’s account |
| twinId string | URN of the transferred Twin |
| region string | |
| schemaVersion int | Schema version used by the models of this twin |
| schemaVersionUpgradeTriggered int | timestamp of the last attempt to trigger a schema upgrade |
| skipRoomBounders boolean | Don’t assign walls/ceilings/floors to rooms |
| template object | |
| classificationId string | Unique identifier of classification |
| description string | Description of template |
| name string | Template name |
| psetIds array: string | List of parameter ids |
| uuid string | Unique identifier of template |
| thumbnailLastUpdate int | Timestamp of the last thumbnail update in Unix milliseconds. |
Example
This example demonstrates successfully getting the list of twins associcated with a given group (aka “account”).
Request
curl -v 'https://developer.api.autodesk.com/tandem/v1/groups/urn:adsk.dtg:ysqziKwTSCejQaUVfqj32Q/twins'' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsIm....'
Response
{
"urn:adsk.dtt:-8oDh9umTuiF5yH9nBuZvQ": {
"links": [
{
"disciplines": null,
"label": "Urban House - JMA.rvt",
"main": true,
"modelId": "urn:adsk.dtm:eyI8J5VNQE6YtacoGL7G6g",
"on": true,
"accessLevel": "Owner"
},
{
"disciplines": null,
"label": "",
"main": false,
"modelId": "urn:adsk.dtm:-8oDh9umTuiF5yH9nBuZvQ",
"on": true,
"accessLevel": "Owner"
}
],
"docs": null,
"props": {
"Identity Data": {
"Address": "20 W 34th St, New York, NY 10001",
"Building Name": "Urban House",
"Owner": "Dr. J",
"Project Name": "City Pad"
},
"Other": {
"Project Number": ""
}
},
"dateCreated": "2022-05-26T22:24:33Z",
"boundByUpperFloor": false,
"skipRoomBounders": false,
"template": {
"uuid": "VgDSH7B0Rvi_Wctsaq7gQQ",
"name": "JMA Test",
"description": "used for API demos",
"classificationId": "masterformat",
"psetIds": [
"VgDSH7B0Rvi_Wctsaq7gQQ"
]
},
"accessLevel": "Owner",
"accountGroup": "urn:adsk.dtg:ysqziKwTSCejQaUVfqj32Q",
"accountType": "free",
"dateModified": "2022-12-23T02:00:19Z",
"etag": "1671760819156"
},
"urn:adsk.dtt:AK5YgLWuQ1OHBhmm2FxD5Q": {
"links": [
{
"disciplines": null,
"label": "rac_basic_sample_project 2022.rvt",
"main": true,
"modelId": "urn:adsk.dtm:bC9ilihYSiaoYhW8Szw0gw",
"on": true,
"accessLevel": "Owner"
}
],
"docs": null,
"props": {
"Identity Data": {
"Address": "206 Washington St, Boston, MA 02109",
"Building Name": "RAC Sample",
"Owner": "Autodesk, Inc.",
"Project Name": "Revit Sample Model"
},
"Other": {
"Project Number": ""
}
},
"dateCreated": "2022-05-26T22:29:13Z",
"boundByUpperFloor": false,
"skipRoomBounders": false,
"template": {
"uuid": "VgDSH7B0Rvi_Wctsaq7gQQ",
"name": "JMA Test",
"description": "used for API demos",
"classificationId": "masterformat",
"psetIds": [
"VgDSH7B0Rvi_Wctsaq7gQQ"
]
},
"accessLevel": "Owner",
"accountGroup": "urn:adsk.dtg:ysqziKwTSCejQaUVfqj32Q",
"accountType": "free",
"dateModified": "2022-05-26T22:29:27Z",
"etag": "1653604167026"
},
"urn:adsk.dtt:FECDWDfQTAeraxkA4AtpVA": {
"links": [
{
"disciplines": null,
"label": "ADSK Toronto 661 University - MaRS BUILDINGS NEW_r17.rvt",
"main": true,
"modelId": "urn:adsk.dtm:GRu40V7zTeKXO9GRqUNLOA",
"on": true,
"accessLevel": "Owner"
},
{
"disciplines": null,
"label": "ADSK Toronto 661 University - MEP NEW_r17.rvt",
"main": false,
"modelId": "urn:adsk.dtm:3SfHepTkS0WWHPRDgkRfOw",
"on": false,
"accessLevel": "Owner"
},
{
"disciplines": null,
"label": "ADSK Toronto 661 University - ARCH NEW_r17.rvt",
"main": false,
"modelId": "urn:adsk.dtm:FSnK8jPSRx-QWTU2W4nUyQ",
"on": false,
"accessLevel": "Owner"
}
],
"docs": null,
"props": {
"Identity Data": {
"Address": "661 University Ave, Toronto, ON M5G 1M1, Canada",
"Building Name": "Mars",
"Owner": "Mr. Z",
"Project Name": "Mars - Toronto"
},
"Other": {
"Project Number": ""
}
},
"dateCreated": "2022-05-25T22:38:14Z",
"boundByUpperFloor": false,
"skipRoomBounders": false,
"template": {
"uuid": "VgDSH7B0Rvi_Wctsaq7gQQ",
"name": "JMA Test",
"description": "used for API demos",
"classificationId": "masterformat",
"psetIds": [
"VgDSH7B0Rvi_Wctsaq7gQQ"
]
},
"accessLevel": "Owner",
"accountGroup": "urn:adsk.dtg:ysqziKwTSCejQaUVfqj32Q",
"accountType": "free",
"dateModified": "2022-05-26T22:18:06Z",
"etag": "1653603486251"
}
}
Show More