Request

Response

    Queries

    project

    query

    Retrieves an object representing a project from a specified hub.

    A project is a shared workspace for teams of people to store, organize, and manage all related design data.

    Template for Query:

    query GetProject($projectId: ID!) {
      project(projectId: $projectId) {
        # Project Fields
      }
    }
    

    Arguments

    projectId*
    ID! non-null
    The ID of the project to retrieve.
    * Required

    Possible Returns

    Value TypeDescription
    Project Represents a project. A project is a shared workspace for teams of people working together on a project, to store, organize, and manage all related entity data.


    Examples

    Example 1

    Retrieves a project by ID along with the hub it belongs to and the items in that project by folder.

    Query:

    query GetProject($projectId: ID!) {
           project(projectId: $projectId) {
               id
               name
               hub {
                   id
                   name
               }
               alternativeIdentifiers{
                   dataManagementAPIProjectId
               }
               folders {
                   results {
                       id
                       name
                       objectCount
                       folders {
                           results {
                               id
                               name
                               __typename
                           }
                       }
                       items {
                           results {
                               id
                               name
                               __typename
                           }
                       }
                   }
               }
           }
     }
    
    Show More

    Query Variables:

    {
     "projectId": "urn:adsk.workspace:beta.project:99497e80-4c1f-4ca7-8132-4bf1735e4d68"
    }
    

    Response:

    {
       "data": {
           "project": {
               "id": "urn:adsk.workspace:beta.project:99497e80-4c1f-4ca7-8132-4bf1735e4d68",
               "name": "Espresso Machine",
               "hub": {
                   "id": "urn:adsk.ace:beta.scope:02dd340f-3e84-4db8-b6a1-56a964a202c7",
                   "name": "Manufacturing Data Model API Version 3"
               },
               "alternativeIdentifiers": {
                   "dataManagementAPIProjectId": "a.YnVzaW5lc3M6eW9wbWFpbDkxNjMjMjAyNjAxMTYxMzMwOTc1MDE"
               },
               "folders": {
                   "results": [
                       {
                           "id": "urn:adsk.wipstg:fs.folder:co.DpsNrdmORlWe_D5G1GIxiQ",
                           "name": "PCB",
                           "objectCount": 1,
                           "folders": {
                               "results": []
                           },
                           "items": {
                               "results": [
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:TTz5-D7RT16rOSq1HEpZAg",
                                       "name": "Espresso PCB",
                                       "__typename": "DesignItem"
                                   }
                               ]
                           }
                       },
                       {
                           "id": "urn:adsk.wipstg:fs.folder:co.quEik8frQn6SJBINysuqJw",
                           "name": "Connectors",
                           "objectCount": 3,
                           "folders": {
                               "results": [
                                   {
                                       "id": "urn:adsk.wipstg:fs.folder:co.e1RDpnm3TjaqIr_ZOy9RFA",
                                       "name": "Folder 01",
                                       "__typename": "Folder"
                                   }
                               ]
                           },
                           "items": {
                               "results": [
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:CDZwg3U8QTmJxvqarNU71A",
                                       "name": "Connector 70",
                                       "__typename": "DesignItem"
                                   },
                                   {
                                       "id": "urn:adsk.wipstg:dm.lineage:avHuvfAgRF-29KmOJq7CZQ",
                                       "name": "Connector",
                                       "__typename": "DesignItem"
                                   }
                               ]
                           }
                       }
                   ]
               }
           }
       }
    }
    
    Show More

    Example 2

    Retrieves the thumbnail Url of project

    Query:

    query Project($projectId: ID!) {
       project(projectId: $projectId) {
           id
           name
           thumbnailUrl
       }
     }
    

    Query Variables:

    {
     "projectId": "urn:adsk.workspace:beta.project:3992ee46-d3ff-47aa-b43e-b0aeabacbf61"
    }
    

    Response:

    {
       "data": {
           "project": {
               "id": "urn:adsk.workspace:beta.project:3992ee46-d3ff-47aa-b43e-b0aeabacbf61",
               "name": "Default Project",
               "thumbnailUrl": "https://static.staging.autodesk360.com/static/10.91.0.880a8068c9/communities/images/logos/biggerThumb/defaultProjectImage_05.png"
           }
       }
    }
    
    Show More

    Example 3

    Retrieves the Fusion web URL that will redirect to the Fusion web.

    Query:

    query Project($projectId: ID!) {
       project(projectId: $projectId) {
           id
           name
           fusionWebUrl
       }
     }
    

    Query Variables:

    {
     "projectId": "urn:adsk.workspace:beta.project:3992ee46-d3ff-47aa-b43e-b0aeabacbf61"
    }
    

    Response:

    {
       "data": {
           "project": {
               "id": "urn:adsk.workspace:beta.project:3992ee46-d3ff-47aa-b43e-b0aeabacbf61",
               "name": "Default Project",
               "fusionWebUrl": "https://yopmail9163.staging.autodesk360.com/portal/groups/20260116133096051/home/Default+Project"
           }
       }
    }
    
    Show More

    Example 4

    Retrieves a project by ID along with its groups.

    Query:

    query GetProject($projectId: ID!, $pagination: PaginationInput) {
       project(projectId: $projectId) {
           name
           id
           __typename
           groups(pagination: $pagination) {
               results {
                   id
                   name
                   role
               }
               pagination {
                   cursor
                   pageSize
               }
           }
       }
     }
    
    Show More

    Query Variables:

    {
     "projectId": "urn:adsk.workspace:beta.project:e0b62c50-ed1d-4322-a951-a05e2d75845a",
      "pagination": {
       "cursor": "MH41"
     }
    }
    

    Response:

    {
       "data": {
           "project": {
               "name": "Docs Project",
               "id": "urn:adsk.workspace:beta.project:e0b62c50-ed1d-4322-a951-a05e2d75845a",
               "__typename": "Project",
               "groups": {
                   "results": [
                       {
                           "id": "327741550",
                           "name": "admins",
                           "role": "ADMINISTRATOR"
                       },
                       {
                           "id": "566929135",
                           "name": "DocGroup1793373238084",
                           "role": "MANAGER"
                       }
                   ],
                   "pagination": {
                       "cursor": null,
                       "pageSize": 2
                   }
               }
           }
       }
    }
    
    Show More

    Example 5

    Retrieves role of groups in project.

    Query:

    query GetProject($projectId: ID!, $pagination: PaginationInput) {
       project(projectId: $projectId) {
           name
           id
           __typename
           groups(pagination: $pagination) {
               results {
                   id
                   name
                   role
               }
               pagination {
                   cursor
                   pageSize
               }
           }
       }
     }
    
    Show More

    Query Variables:

    {
     "projectId": "urn:adsk.workspace:beta.project:e0b62c50-ed1d-4322-a951-a05e2d75845a",
      "pagination": {
       "cursor": "MH41"
     }
    }
    

    Response:

    {
       "data": {
           "project": {
               "name": "Docs Project",
               "id": "urn:adsk.workspace:beta.project:e0b62c50-ed1d-4322-a951-a05e2d75845a",
               "__typename": "Project",
               "groups": {
                   "results": [
                       {
                           "id": "327741550",
                           "name": "admins",
                           "role": "ADMINISTRATOR"
                       },
                       {
                           "id": "566929135",
                           "name": "DocGroup1793373238084",
                           "role": "MANAGER"
                       }
                   ],
                   "pagination": {
                       "cursor": null,
                       "pageSize": 2
                   }
               }
           }
       }
    }
    
    Show More

    Example 6

    Retrieves project members with their roles and user information.

    Query:

    query GetProjectMembers($projectId: ID!) {
     project(projectId: $projectId) {
       id
       name
       members {
         results {
           avatarUrl
           displayName
           role
           user {
             id
             firstName
             lastName
             email
           }
         }
         pagination {
           cursor
           pageSize
         }
       }
     }
     }
    
    Show More

    Query Variables:

    {
     "projectId": "urn:adsk.workspace:beta.project:99497e80-4c1f-4ca7-8132-4bf1735e4d68"
    }
    

    Response:

    {
       "data": {
           "project": {
               "id": "urn:adsk.workspace:beta.project:99497e80-4c1f-4ca7-8132-4bf1735e4d68",
               "name": "Espresso Machine",
               "members": {
                   "results": [
                       {
                           "avatarUrl": null,
                           "displayName": "Raghav Patel",
                           "role": "ADMINISTRATOR",
                           "user": {
                               "id": "GRM22PZYJAFDX2WJ",
                               "firstName": "Raghav",
                               "lastName": "Patel",
                               "email": "demo.docs@yopmail.com"
                           }
                       },
                       {
                           "avatarUrl": null,
                           "displayName": "Sasikanth Kollipara",
                           "role": "ADMINISTRATOR",
                           "user": {
                               "id": "Q78AJUBH7YGT",
                               "firstName": "Sasikanth",
                               "lastName": "Kollipara",
                               "email": "demo.docs@yopmail.com"
                           }
                       },
                       {
                           "avatarUrl": null,
                           "displayName": "Shaunak Thakar",
                           "role": "ADMINISTRATOR",
                           "user": {
                               "id": "6TB26FHBPVZXCT6M",
                               "firstName": "Shaunak",
                               "lastName": "Thakar",
                               "email": "demo.docs@yopmail.com"
                           }
                       }
                   ],
                   "pagination": {
                       "cursor": null,
                       "pageSize": 3
                   }
               }
           }
       }
    }
    
    Show More