openapi: 3.0.0 x-stoplight: id: zm6m3b30rcbon info: title: Construction.Account.Admin version: '1.0' contact: name: Autodesk Plaform Services url: 'https://aps.autodesk.com/' email: aps.help@autodesk.com termsOfService: 'https://www.autodesk.com/company/legal-notices-trademarks/terms-of-service-autodesk360-web-services/forge-platform-web-services-api-terms-of-service' x-support: 'https://stackoverflow.com/questions/tagged/autodesk-platform-services' description: | The Account Admin API automates creating and managing projects, assigning and managing project users, and managing member and partner company directories. You can also synchronize data with external systems. servers: - url: 'https://developer.api.autodesk.com' paths: '/construction/admin/v1/accounts/{accountId}/projects': parameters: - schema: type: string name: accountId in: path required: true description: 'The ID of the ACC account that contains the project being created or the projects being retrieved. This corresponds to the hub ID in the Data Management API. To convert a hub ID into an account ID, remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' get: summary: Get Project in account responses: '200': description: A list of requested projects. content: application/json: schema: $ref: '#/components/schemas/ProjectsPage' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Unauthorized '403': description: Forbidden '404': description: Resource Not Found '406': description: Not Acceptable '410': description: Access to the target resource is no longer available. '429': description: User has sent too many requests in a given amount of time. '500': description: Internal Server Error '503': description: Service Unavailable operationId: getProjects description: Retrieves a list of the projects in the specified account. parameters: - schema: type: string in: header name: Accept-Language description: This header is not currently supported in the Account Admin API. - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The region where the bucket resides. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR.' - schema: type: string in: header name: User-Id description: 'Note that this header is not relevant for Account Admin GET endpoints. The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId).' - schema: $ref: '#/components/schemas/fields_internal' in: query name: fields description: 'A comma-separated list of the project fields to include in the response. Default value: all fields.' - schema: $ref: '#/components/schemas/filterClassification_internal' in: query name: 'filter[classification]' description: 'A list of the classifications of projects to include in the response. Possible values: production, template, component, sample.' - schema: $ref: '#/components/schemas/filterPlatform_internal' in: query name: 'filter[platform]' description: 'Filter resource by platform. Possible values: acc and bim360.' - schema: $ref: '#/components/schemas/products_internal' in: query name: 'filter[products]' description: A comma-separated list of the products that the returned projects must use. Only projects that use one or more of the listed products are returned. - schema: type: string in: query name: 'filter[name]' description: 'A project name or name pattern to filter projects by. Can be a partial match based on the value of filterTextMatch that you provide; for example: filter[name]=ABCco filterTextMatch=startsWith. Max length: 255' - schema: $ref: '#/components/schemas/filterType' in: query name: 'filter[type]' description: 'A list of project types to filter projects by. To exclude a project type from the response, prefix it with - (a hyphen); for example, -Bridge excludes bridge projects.' - schema: $ref: '#/components/schemas/status_internal' in: query name: 'filter[status]' description: 'A list of the statuses of projects to include in the response. Possible values: active pending archived suspended' - schema: type: string in: query name: 'filter[businessUnitId]' description: The ID of the business unit that returned projects must be associated with. - schema: type: string in: query name: 'filter[jobNumber]' description: The user-defined identifier for a project to be returned. This ID was defined when the project was created. This filter accepts a partial match based on the value of filterTextMatch that you provide. - schema: type: string in: query name: 'filter[updatedAt]' description: A range of dates during which the desired projects were updated. The range must be specified with dates in ISO 8601 format with time required. Separate multiple values with commas. - schema: $ref: '#/components/schemas/filterTextMatch' in: query name: filterTextMatch description: 'When filtering on a text-based field, this value indicates how to do the matching. Default value: contains. Possible values: contains, startsWith, endsWith and equals.' - schema: $ref: '#/components/schemas/sort_internal' in: query name: sort description: A list of fields to sort the returned projects by. Multiple sort fields are applied in sequence order — each sort field produces groupings of projects with the same values of that field; the next sort field applies within the groupings produced by the previous sort field. - schema: type: integer in: query name: limit description: 'The maximum number of records to return in a single request. Possible range: 1-200. Default value: 20.' - schema: type: integer in: query name: offset description: 'The record number that the returned page should start with. When the total number of records exceeds the value of limit, increase the offset value in subsequent requests to continue getting the remaining results.' security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] tags: - Projects post: summary: Create new Project responses: '202': description: APS has received the request but not yet completed it. content: application/json: schema: $ref: '#/components/schemas/Project' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Unauthorized '403': description: Forbidden '404': description: Resource Not Found '406': description: Not Acceptable '410': description: Access to the target resource is no longer available. '415': description: The server refuses to accept the request because the payload format is in an unsupported format. '429': description: User has sent too many requests in a given amount of time. '500': description: Internal Server Error '503': description: Service Unavailable operationId: createProject description: 'Creates a new project in the specified account. You can create the project directly, or clone the project from a project template.' parameters: - schema: type: string in: header name: Accept-Language description: This header is not currently supported in the Account Admin API. - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The region where the bucket resides. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR.' - schema: type: string in: header name: User-Id description: 'Note that this header is not relevant for Account Admin GET endpoints. The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId).' security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] tags: - Projects requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectPayload' '/construction/admin/v1/projects/{projectId}': parameters: - schema: type: string name: projectId in: path required: true get: summary: Get a project by ID responses: '200': description: A list of requested projects. content: application/json: schema: $ref: '#/components/schemas/Project' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Unauthorized '403': description: Forbidden '404': description: Resource Not Found '406': description: Not Acceptable '407': description: Proxy Authentication Required '410': description: Access to the target resource is no longer available. '429': description: User has sent too many requests in a given amount of time. '500': description: Internal Server Error '503': description: Service Unavailable operationId: getProject description: Retrieves a project specified by project ID. parameters: - schema: type: string in: header name: Accept-Language description: This header is not currently supported in the Account Admin API. - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The region where the bucket resides. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR.' - schema: type: string in: header name: User-Id description: 'Note that this header is not relevant for Account Admin GET endpoints. The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId).' - in: query name: fields description: 'A comma-separated list of the project fields to include in the response. Default value: all fields.' schema: $ref: '#/components/schemas/fields_internal' security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] tags: - Projects '/hq/v1/accounts/{account_id}/projects/{project_id}/image': patch: summary: Create or update a project’s image operationId: createProjectImage responses: '200': description: A list of requested projects. content: application/json: schema: $ref: '#/components/schemas/ProjectPatch' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: Conflict '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error description: Create or update a project’s image. security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] requestBody: content: application/x-www-form-urlencoded: schema: required: - body properties: body: type: string description: 'The file to be uploaded as HTTP multipart (chunk) data. Supported MIME types are image/png, image/jpeg, image/jpg, image/bmp, and image/gif.' format: binary tags: - Projects parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' parameters: - schema: type: string name: project_id in: path required: true description: 'The account ID of the project. This corresponds to hub ID in the Data Management API. To convert a hub ID into an account ID you need to remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' - schema: type: string name: account_id in: path required: true description: 'The ID of the project. This corresponds to project ID in the Data Management API. To convert a project ID in the Data Management API into a project ID in the BIM 360 API you need to remove the “b.” prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7.' '/hq/v1/accounts/{account_id}/companies': parameters: - schema: type: string name: account_id in: path required: true description: 'The account ID of the company. This corresponds to hub ID in the Data Management API. To convert a hub ID into an account ID you need to remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' get: summary: Get all companies in an account tags: - Companies responses: '200': description: The request has succeeded content: application/json: schema: type: array items: $ref: '#/components/schemas/Company' x-stoplight: id: talz7czxqzv5p '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error operationId: getCompanies description: |- Query all the partner companies in a specific BIM 360 account. Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects. security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' - schema: type: integer in: query name: limit description: 'Response array’s size Default value: 10 Max limit: 100' - schema: type: integer in: query name: offset description: 'Offset of response array Default value: 0' - schema: type: string in: query name: sort description: Comma-separated fields to sort by in ascending order Prepending a field with - sorts in descending order Invalid fields and whitespaces will be ignored - schema: type: string in: query name: field description: Comma-separated fields to include in response id will always be returned Invalid fields will be ignored post: summary: Create a new partner company tags: - Companies parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' responses: '201': description: A new resource has been successfully created. content: application/json: schema: $ref: '#/components/schemas/Company' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error operationId: createCompany description: |- Create a new partner company. Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects. security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyPayload' '/hq/v1/accounts/{account_id}/companies/import': parameters: - schema: type: string name: account_id in: path required: true description: 'The account ID of the company. This corresponds to hub ID in the Data Management API. To convert a hub ID into an account ID you need to remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' post: summary: Bulk import partner companies tags: - Companies parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' responses: '201': description: A new resource has been successfully created. content: application/json: schema: $ref: '#/components/schemas/CompanyImport' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error operationId: importCompanies description: |- Bulk import partner companies to the company directory in a specific BIM 360 account. (50 companies maximum can be included in each call.) Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects. security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/CompanyPayload' x-stoplight: id: oo7x7y92yduxj '/hq/v1/accounts/{account_id}/companies/{company_id}': parameters: - schema: type: string name: company_id in: path required: true description: Company ID - schema: type: string name: account_id in: path required: true description: The account ID of the company. get: summary: Get details of a company tags: - Companies parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' responses: '200': description: The request has succeeded content: application/json: schema: $ref: '#/components/schemas/Company' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error operationId: getCompany description: Query the details of a specific partner company. security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] patch: summary: Update the properties of company operationId: patchCompanyDetails tags: - Companies parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' responses: '200': description: The request has succeeded content: application/json: schema: $ref: '#/components/schemas/Company' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] description: Update the properties of only the specified attributes of a specific partner company. requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyPatchPayload' '/hq/v1/accounts/{account_id}/companies/{company_id}/image': parameters: - schema: type: string name: company_id in: path required: true description: Company ID - schema: type: string name: account_id in: path required: true description: The account ID of the company. patch: summary: Create or update a company’s image operationId: patchCompanyImage parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' tags: - Companies responses: '200': description: The request has succeeded content: application/json: schema: $ref: '#/components/schemas/Company' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] description: Create or update a specific partner company’s image. requestBody: content: application/x-www-form-urlencoded: schema: required: - body properties: body: type: string description: 'The file to be uploaded as HTTP multipart (chunk) data. Supported MIME types are image/png, image/jpeg, image/jpg, image/bmp, and image/gif.' format: binary '/hq/v1/accounts/{account_id}/companies/search': parameters: - schema: type: string name: account_id in: path required: true description: The account ID of the company. get: summary: Search companies in account by name tags: - Companies responses: '200': description: The request has succeeded content: application/json: schema: type: array items: $ref: '#/components/schemas/Company' x-stoplight: id: lcdrvybcvuy9t '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error operationId: searchCompanies description: |- Search partner companies in a specific BIM 360 account by name. Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects. security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' - schema: type: string in: query name: name description: 'Company name to match Max length: 255' - schema: type: string in: query name: trade description: 'Company trade to match Max length: 255' - schema: type: string in: query name: operator description: 'Boolean operator to use: OR (default) or AND' - schema: type: boolean in: query name: partial description: 'If true (default), perform a fuzzy match' - schema: type: integer in: query name: limit description: 'Response array’s size Default value: 10 Max limit: 100' - schema: type: integer in: query name: offset description: 'Offset of response array Default value: 0' - schema: type: string in: query name: sort description: Comma-separated fields to sort by in ascending order - schema: type: string in: query name: field description: Comma-separated fields to include in response '/hq/v1/accounts/{account_id}/projects/{project_id}/companies': parameters: - schema: type: string name: account_id in: path required: true description: The account ID of the company. - schema: type: string name: project_id in: path required: true description: 'The ID of the project. ' get: summary: Get all companies in a project tags: - Companies responses: '200': description: The request has succeeded content: application/json: schema: type: array items: $ref: '#/components/schemas/ProjectCompanies' x-stoplight: id: lcdrvybcvuy9t '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error operationId: getProjectCompanies description: |- Query all the partner companies in a specific BIM 360 project. Note that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects. security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' - schema: type: integer in: query name: limit description: 'Response array’s size Default value: 10 Max limit: 100' - schema: type: integer in: query name: offset description: 'Offset of response array Default value: 0' - schema: type: string in: query name: sort description: Comma-separated fields to sort by in ascending order - schema: type: string in: query name: field description: Comma-separated fields to include in response '/hq/v1/accounts/{account_id}/users': parameters: - schema: type: string name: account_id in: path required: true description: 'The account ID of the users. This corresponds to hub ID in the Data Management API. To convert a hub ID into an account ID you need to remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' get: summary: Get account users responses: '200': description: The request has succeeded content: application/json: schema: type: array items: $ref: '#/components/schemas/User' x-stoplight: id: lcdrvybcvuy9t '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error operationId: getUsers description: Query all the users in a specific BIM 360 account. security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' - schema: type: integer in: query name: limit description: 'Response array’s size Default value: 10 Max limit: 100' - schema: type: integer in: query name: offset description: 'Offset of response array Default value: 0' - schema: type: string in: query name: sort description: Comma-separated fields to sort by in ascending order - schema: type: string in: query name: field description: Comma-separated fields to include in response tags: - Account Users post: summary: Create User operationId: createUser parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' responses: '201': description: A new resource has been successfully created. content: application/json: schema: $ref: '#/components/schemas/User' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] description: Create a new user in the BIM 360 member directory. tags: - Account Users requestBody: content: application/json: schema: $ref: '#/components/schemas/UserPayload' '/hq/v1/accounts/{account_id}/users/import': parameters: - schema: type: string name: account_id in: path required: true description: 'The account ID of the users. This corresponds to hub ID in the Data Management API. To convert a hub ID into an account ID you need to remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' post: summary: Bulk import users parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' responses: '201': description: A new resource has been successfully created. content: application/json: schema: $ref: '#/components/schemas/UserImport' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error operationId: importUsers description: Bulk import users to the master member directory in a BIM 360 account. (50 users maximum can be included in each call.) security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/UserPayload' x-stoplight: id: oo7x7y92yduxj tags: - Account Users '/hq/v1/accounts/{account_id}/users/{user_id}': parameters: - schema: type: string name: account_id in: path required: true description: The account ID of the user. - schema: type: string name: user_id in: path required: true description: User ID get: summary: Get the details of a user responses: '200': description: The request has succeeded content: application/json: schema: $ref: '#/components/schemas/User' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error operationId: getUser parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' description: Query the details of a specific user. security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] tags: - Account Users patch: summary: Update User operationId: patchUserDetails parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' responses: '200': description: The request has succeeded content: application/json: schema: $ref: '#/components/schemas/User' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] description: Update a specific user’s status or default company. requestBody: content: application/json: schema: $ref: '#/components/schemas/UserPatchPayload' tags: - Account Users '/hq/v1/accounts/{account_id}/users/search': parameters: - schema: type: string name: account_id in: path required: true description: The account ID of the users. get: summary: Search Users responses: '200': description: The request has succeeded content: application/json: schema: type: array items: $ref: '#/components/schemas/User' x-stoplight: id: lcdrvybcvuy9t '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource '422': description: The request was unable to be followed due to restrictions. '500': description: Internal Server Error operationId: searchUsers description: Search users in the master member directory of a specific BIM 360 account by specified fields. security: - 2-legged: [] - 3-legged: [] - 3-legged-implicit: [] parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' - schema: type: string in: query name: name description: 'User name to match Max length: 255' - schema: type: string in: query name: email description: 'User email to match Max length: 255' - schema: type: string in: query name: company_name description: 'User company to match Max length: 255' - schema: type: string in: query name: operator description: 'Boolean operator to use: OR (default) or AND' - schema: type: boolean in: query name: partial description: 'If true (default), perform a fuzzy match' - schema: type: integer in: query name: limit description: 'Response array’s size Default value: 10 Max limit: 100' - schema: type: integer in: query name: offset description: 'Offset of response array Default value: 0' - schema: type: string in: query name: sort description: Comma-separated fields to sort by in ascending order - schema: type: string in: query name: field description: Comma-separated fields to include in response tags: - Account Users '/construction/admin/v1/projects/{projectId}/users': parameters: - schema: type: string name: projectId in: path required: true description: 'The ID of the project. This corresponds to project ID in the Data Management API. To convert a project ID in the Data Management API into a project ID in the ACC API you need to remove the “b.” prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7.' get: summary: Get project users responses: '200': description: A list of requested project users. content: application/json: schema: $ref: '#/components/schemas/ProjectUsersPage' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Unauthorized '403': description: Forbidden '404': description: Resource Not Found '406': description: Not Acceptable '410': description: Access to the target resource is no longer available. '429': description: User has sent too many requests in a given amount of time. '500': description: Internal Server Error '503': description: Service Unavailable operationId: getProjectUsers description: |- Retrieves information about a filtered subset of users in the specified project. There are two primary reasons to do this: To verify that all users assigned to the project have been activated as members of the project. To check other information about users, such as their project user ID, roles, and products. Note that if you want to retrieve information about users associated with a particular Autodesk account, call the GET users endpoint. parameters: - schema: type: string in: header name: Accept-Language description: This header is not currently supported in the Account Admin API. - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The region where the bucket resides. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR.' - schema: type: string in: header name: User-Id description: 'Note that this header is not relevant for Account Admin GET endpoints. The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId).' - schema: $ref: '#/components/schemas/products_internal' in: query name: 'filter[products]' description: A comma-separated list of the products that the returned projects must use. Only projects that use one or more of the listed products are returned. - schema: type: string in: query name: 'filter[name]' description: 'A user name or name pattern to filter users by. Can be a partial match based on the value of filterTextMatch that you provide; for example: filter[name]=ABCco filterTextMatch=startsWith. Max length: 255' - schema: type: string in: query name: 'filter[email]' description: 'A user email address or address pattern that the returned users must have. This can be a partial match based on the value of filterTextMatch that you provide. For example: filter[email]=sample filterTextMatch=startsWith Max length: 255' - schema: $ref: '#/components/schemas/statusFilter_internal' in: query name: 'filter[status]' description: A list of statuses that the returned project users must be in. The default values are active and pending. - schema: $ref: '#/components/schemas/accessLevels_internal' in: query name: 'filter[accessLevels]' description: A list of user access levels that the returned users must have. - schema: type: string in: query name: 'filter[companyId]' description: The ID of a company that the returned users must represent. - schema: type: string in: query name: 'filter[companyName]' description: 'The name of a company that returned users must be associated with. Can be a partial match based on the value of filterTextMatch that you provide. For example: filter[companyName]=Sample filterTextMatch=startsWith Max length: 255' - schema: $ref: '#/components/schemas/filterAutodeskId' in: query name: 'filter[autodeskId]' description: A list of the Autodesk IDs of users to retrieve. - schema: $ref: '#/components/schemas/filterID' in: query name: 'filter[id]' description: A list of the ACC IDs of users to retrieve. - schema: type: string in: query name: 'filter[roleId]' description: 'The ID of a user role that the returned users must have. To obtain a role ID for this filter, you can inspect the roleId field in previous responses to this endpoint or to the GET projects/:projectId/users/:userId endpoint. Max length: 255' - schema: $ref: '#/components/schemas/filterRoleIds' in: query name: 'filter[roleIds]' description: 'A list of the IDs of user roles that the returned users must have. To obtain a role ID for this filter, you can inspect the roleId field in previous responses to this endpoint or to the GET projects/:projectId/users/:userId endpoint.' - schema: $ref: '#/components/schemas/userSortBy_internal' in: query name: sort description: A list of fields to sort the returned users by. Multiple sort fields are applied in sequence order — each sort field produces groupings of projects with the same values of that field; the next sort field applies within the groupings produced by the previous sort field. - schema: $ref: '#/components/schemas/userFields_internal' in: query name: fields description: 'A list of the project fields to include in the response. Default value: all fields.' - schema: $ref: '#/components/schemas/orFilters_internal' in: query name: orFilters description: A list of user fields to combine with the SQL OR operator for filtering the returned project users. The OR is automatically incorporated between the fields; any one of them can produce a valid match. - schema: $ref: '#/components/schemas/filterTextMatch' in: query name: filterTextMatch description: 'When filtering on a text-based field, this value indicates how to do the matching. Default value: contains. Possible values: contains, startsWith, endsWith and equals.' - schema: type: integer in: query name: limit description: 'The maximum number of records to return in a single request. Possible range: 1-200. Default value: 20.' - schema: type: integer in: query name: offset description: 'The record number that the returned page should start with. When the total number of records exceeds the value of limit, increase the offset value in subsequent requests to continue getting the remaining results.' security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] tags: - Project Users post: summary: Assigns a user to the specified project responses: '201': description: Successfully added the user to the project. content: application/json: schema: $ref: '#/components/schemas/ProjectUserDetails' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Unauthorized '403': description: Forbidden '404': description: Resource Not Found '406': description: Not Acceptable '410': description: Access to the target resource is no longer available. '412': description: The server refuses to accept the request because a pre-condition failed. '415': description: The server refuses to accept the request because the payload format is in an unsupported format. '429': description: User has sent too many requests in a given amount of time. '500': description: Internal Server Error '503': description: Service Unavailable operationId: assignProjectUser description: Assigns a user to the specified project. parameters: - schema: type: string in: header name: Accept-Language description: This header is not currently supported in the Account Admin API. - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The region where the bucket resides. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR.' - schema: type: string in: header name: User-Id description: 'Note that this header is not relevant for Account Admin GET endpoints. The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId).' security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectUserPayload' tags: - Project Users '/construction/admin/v2/projects/{projectId}/users:import': parameters: - schema: type: string name: projectId in: path required: true description: 'The ID of the project. This corresponds to project ID in the Data Management API. To convert a project ID in the Data Management API into a project ID in the ACC API you need to remove the “b.” prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7.' post: summary: Assigns multiple users to a project responses: '202': description: The request has been received but not yet acted upon. content: application/json: schema: $ref: '#/components/schemas/ProjectUsersImport' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Unauthorized '403': description: Forbidden '404': description: Resource Not Found '406': description: Not Acceptable '410': description: Access to the target resource is no longer available. '412': description: The server refuses to accept the request because a pre-condition failed. '415': description: The server refuses to accept the request because the payload format is in an unsupported format. '429': description: User has sent too many requests in a given amount of time. '500': description: Internal Server Error '503': description: Service Unavailable operationId: importProjectUsers description: Assigns multiple users to a project at once. This endpoint can assign up to 200 users per request. parameters: - schema: type: string in: header name: Accept-Language description: This header is not currently supported in the Account Admin API. - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The region where the bucket resides. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR.' - schema: type: string in: header name: User-Id description: 'Note that this header is not relevant for Account Admin GET endpoints. The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId).' security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectUsersImportPayload' tags: - Project Users '/construction/admin/v1/projects/{projectId}/users/{userId}': parameters: - schema: type: string name: projectId in: path required: true description: 'The ID of the project. This corresponds to project ID in the Data Management API. To convert a project ID in the Data Management API into a project ID in the ACC API you need to remove the “b.” prefix. For example, a project ID of b.a4be0c34a-4ab7 translates to a project ID of a4be0c34a-4ab7.' - schema: type: string name: userId in: path required: true description: The ID of the user. You can use either the ACC ID (id) or the Autodesk ID (autodeskId). get: summary: Get project user responses: '200': description: Information about the requested project user. content: application/json: schema: $ref: '#/components/schemas/ProjectUser' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Unauthorized '403': description: Forbidden '404': description: Resource Not Found '406': description: Not Acceptable '410': description: Access to the target resource is no longer available. '429': description: User has sent too many requests in a given amount of time. '500': description: Internal Server Error '503': description: Service Unavailable operationId: getProjectUser description: |- Retrieves detailed information about the specified user in a project. There are two primary reasons to do this: To verify that a user assigned to the specified project has been activated as a member of the project. To check other information about the user, such as their project user ID, roles, and products. parameters: - schema: type: string in: header name: Accept-Language description: This header is not currently supported in the Account Admin API. - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The region where the bucket resides. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR.' - schema: type: string in: header name: User-Id description: 'Note that this header is not relevant for Account Admin GET endpoints. The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId).' - schema: $ref: '#/components/schemas/userFields_internal' in: query name: fields description: 'A comma-separated list of the project fields to include in the response. Default value: all fields.' security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] tags: - Project Users patch: summary: Update user in project responses: '201': description: The project user was successfully updated. The response includes only the fields being updated along with the ACC ID of the user. content: application/json: schema: $ref: '#/components/schemas/ProjectUserDetails' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Unauthorized '403': description: Forbidden '404': description: Resource Not Found '406': description: Not Acceptable '410': description: Access to the target resource is no longer available. '412': description: The server refuses to accept the request because a pre-condition failed. '415': description: The server refuses to accept the request because the payload format is in an unsupported format. '429': description: User has sent too many requests in a given amount of time. '500': description: Internal Server Error '503': description: Service Unavailable operationId: updateProjectUser description: |- Updates information about the specified user in a project. Note that the Authorization header token can be obtained either via a three-legged OAuth flow, or via a two-legged Oauth flow with user impersonation, for which the User-Id header is also required. parameters: - schema: type: string in: header name: Accept-Language description: This header is not currently supported in the Account Admin API. - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The region where the bucket resides. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR.' - schema: type: string in: header name: User-Id description: 'Note that this header is not relevant for Account Admin GET endpoints. The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId).' security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectUsersUpdatePayload' tags: - Project Users delete: summary: Remove Project User responses: '204': description: 'The request has succeeded, no content returned.' content: {} '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Unauthorized '403': description: Forbidden '404': description: Resource Not Found '410': description: Access to the target resource is no longer available. '415': description: The server refuses to accept the request because the payload format is in an unsupported format. '429': description: User has sent too many requests in a given amount of time. '500': description: Internal Server Error '503': description: Service Unavailable operationId: removeProjectUser description: |- Removes the specified user from a project. Note that the Authorization header token can be obtained either via a three-legged OAuth flow, or via a two-legged Oauth flow with user impersonation, for which the User-Id header is also required. parameters: - schema: type: string in: header name: Accept-Language description: This header is not currently supported in the Account Admin API. - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The region where the bucket resides. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR.' - schema: type: string in: header name: User-Id description: 'Note that this header is not relevant for Account Admin GET endpoints. The ID of a user on whose behalf your API request is acting. Required if you’re using a 2-legged authentication context, which must be 2-legged OAuth2 security with user impersonation. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId).' security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] tags: - Project Users '/hq/v1/accounts/{account_id}/business_units_structure': get: summary: Get Business Units responses: '200': description: The request has succeeded content: application/json: schema: $ref: '#/components/schemas/BusinessUnits' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource. '422': description: The request was unable to be followed due to restrictions '500': description: An unexpected error occurred on the server operationId: getBusinessUnits description: Query all the business units in a specific BIM 360 account. security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] tags: - Business Units parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' parameters: - schema: type: string name: account_id in: path required: true description: 'The account ID of the business unit. This corresponds to hub ID in the Data Management API. To convert a hub ID into an account ID you need to remove the “b.” prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' put: summary: Create Business Units responses: '200': description: The request has succeeded content: application/json: schema: $ref: '#/components/schemas/BusinessUnits' '400': description: The request could not be understood by the server due to malformed syntax. '403': description: Forbidden '404': description: Resource Not Found '409': description: The request could not be completed due to a conflict with the current state of the resource. '422': description: The request was unable to be followed due to restrictions '500': description: An unexpected error occurred on the server operationId: createBusinessUnits parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'The geographic area where the data is stored. Acceptable values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. By default, it is set to US.' description: Query all the business units in a specific BIM 360 account. security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] tags: - Business Units requestBody: content: application/json: schema: $ref: '#/components/schemas/BusinessUnitsPayload' '/construction/admin/v1/accounts/{accountId}/users/{userId}/projects': get: summary: Get user projects tags: - User Projects responses: '200': description: A list of requested user projects. content: application/json: schema: $ref: '#/components/schemas/UserProjectsPage' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Request has not been applied because it lacks valid authentication credentials for the target resource. '403': description: The server understood the request but refuses to authorize it. '404': description: The resource cannot be found. '406': description: The server cannot produce a response matching the list of acceptable values defined in the request. '410': description: Access to the target resource is no longer available. '429': description: User has sent too many requests in a given amount of time. '500': description: An unexpected error occurred on the server. '503': description: Server is not ready to handle the request. operationId: getUserProjects x-stoplight: id: f6km4vaercy9d description: Returns a list of projects for a specified user within an Autodesk Construction Cloud (ACC) or BIM 360 account. Only projects the user participates in will be returned. The calling user must be an account administrator. security: [] parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'Specifies the region where your request should be routed. If not set, the request is routed automatically, which may result in a slight increase in latency. Possible values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. For a complete list of supported regions, see the Regions page.' - schema: type: string in: header name: User-Id description: 'The ID of a user on whose behalf your request is acting. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId). Note that this header is required for Account Admin POST, PATCH, and DELETE endpoints if you want to use a 2-legged authentication context. This header is optional for Account Admin GET endpoints.' - schema: $ref: '#/components/schemas/filterID' in: query name: 'filter[id]' description: A list of project IDs to filter by. - schema: $ref: '#/components/schemas/userProjectFields_internal' in: query name: fields description: 'A comma-separated list of user project fields to include in the response. If not specified, all available fields are included by default. Possible values: accessLevels, accountId, addressLine1, addressLine2, city, constructionType, country, createdAt, classification, deliveryMethod, endDate, imageUrl, jobNumber, latitude, longitude, name, platform, postalCode, projectValue, sheetCount, startDate, stateOrProvince, status, thumbnailImageUrl, timezone, type, updatedAt, contractType and currentPhase.' - schema: $ref: '#/components/schemas/filterClassification_internal' in: query name: 'filter[classification]' description: 'Filters projects by classification. Possible values: production – Standard production projects. template – Project templates that can be cloned to create production projects. component – Placeholder projects that contain standardized components (e.g., forms) for use across projects. Only one component project is permitted per account. Known as a library in the ACC unified products UI. sample – The single sample project automatically created upon ACC trial setup. Only one sample project is permitted per account. Max length: 255' - schema: type: string in: query name: 'filter[name]' description: 'Filters projects by name. Supports partial matches when used with filterTextMatch. For example filter[name]=ABCco&filterTextMatch=startsWith returns projects whose names start with “ABCco”. Max length: 255' - schema: $ref: '#/components/schemas/filterPlatform_internal' in: query name: 'filter[platform]' description: 'Filters by platform. Possible values: acc (Autodesk Construction Cloud) and bim360 (BIM 360). Max length: 255' - schema: $ref: '#/components/schemas/status_internal' in: query name: 'filter[status]' description: 'Filters projects by status. Possible values: active, pending, archived, suspended.' - schema: $ref: '#/components/schemas/filterType' in: query name: 'filter[type]' description: 'Filters by project type. To exclude a type, prefix it with - (e.g., -Bridge excludes bridge projects). Possible values: Airport, Assisted Living / Nursing Home, Bridge, Canal / Waterway, Convention Center, Court House, Data Center, Dams / Flood Control / Reservoirs, Demonstration Project, Dormitory, Education Facility, Government Building, Harbor / River Development, Hospital, Hotel / Motel, Library, Manufacturing / Factory, Medical Laboratory, Medical Office, Military Facility, Mining Facility, Multi-Family Housing, Museum, Oil & Gas,``Plant``, Office, OutPatient Surgery Center, Parking Structure / Garage, Performing Arts, Power Plant, Prison / Correctional Facility, Rail, Recreation Building, Religious Building, Research Facility / Laboratory, Restaurant, Retail, Seaport, Single-Family Housing, Solar Farm, Stadium/Arena, Streets / Roads / Highways, Template Project, Theme Park, Training Project, Transportation Building, Tunnel, Utilities, Warehouse (non-manufacturing), Waste Water / Sewers, Water Supply, Wind Farm.' - schema: type: string in: query name: 'filter[jobNumber]' description: 'Filters by a user-defined project identifier. Supports partial matches when used with filterTextMatch. For example, filter[jobNumber]=HP-0002&filterTextMatch=equals returns projects where the job number is exactly “HP-0002”. Max length: 255' - schema: type: string in: query name: 'filter[updatedAt]' description: 'Filters projects updated within a specific date range in ISO 8601 format. For example: Date range: 2023-03-02T00:00:00.000Z..2023-03-03T23:59:59 .999Z Specific start date: 2023-03-02T00:00:00.000Z.. Specific end date: ..2023-03-02T23:59:59.999Z For more details, see JSON API Filtering. Max length: 100' - schema: $ref: '#/components/schemas/userProjectAccessLevels_internal' in: query name: 'filter[accessLevels]' description: 'Filters projects by user access level. Possible values: projectAdmin, projectMember. Max length: 255' - schema: $ref: '#/components/schemas/filterTextMatch' in: query name: filterTextMatch description: 'Defines how text-based filters should match results. Possible values: contains (default) – Returns results where the text appears anywhere in the field. startsWith – Matches only if the field starts with the given value. endsWith – Matches only if the field ends with the given value. equals – Matches only if the field is an exact match.' - schema: $ref: '#/components/schemas/userProjectSortBy_internal' in: query name: sort description: 'A list of fields to sort the returned user projects by. Multiple sort fields are applied in sequence order — each sort field produces groupings of projects with the same values of that field; the next sort field applies within the groupings produced by the previous sort field. Each property can be followed by a direction modifier of either asc (ascending) or desc (descending). The default is asc. Possible values: name (the default), startDate, endDate, type, status, jobNumber, constructionType, deliveryMethod, contractType, currentPhase, createdAt, updatedAt and platform.' - schema: type: integer in: query name: limit description: 'The maximum number of records per request. Default: 20. Minimum: 1, Maximum: 200. If a value greater than 200 is provided, only 200 records are returned.' - schema: type: integer in: query name: offset description: 'The record number to start returning results from, used for pagination. For example, if limit=20 and offset=20, the request retrieves the second page of results.' parameters: - schema: type: string name: accountId in: path required: true description: 'The ID of the ACC account that contains the project being created or the projects being retrieved. This corresponds to the hub ID in the Data Management API. To convert a hub ID into an account ID, remove the “b." prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' - schema: type: string name: userId in: path required: true description: The ID of the user. You can use either the ACC ID (id) or the Autodesk ID (autodeskId). '/construction/admin/v1/accounts/{accountId}/companies': parameters: - schema: type: string name: accountId in: path required: true description: 'The ID of the ACC account that contains the project being created or the projects being retrieved. This corresponds to the hub ID in the Data Management API. To convert a hub ID into an account ID, remove the “b." prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' get: summary: Get account companies tags: - Companies responses: '200': description: The list of requested companies. content: application/json: schema: $ref: '#/components/schemas/CompaniesPage' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Request has not been applied because it lacks valid authentication credentials for the target resource. '403': description: The server understood the request but refuses to authorize it. '404': description: The resource cannot be found. '406': description: The server cannot produce a response matching the list of acceptable values defined in the request. '410': description: Access to the target resource is no longer available. '429': description: User has sent too many requests in a given amount of time. '500': description: An unexpected error occurred on the server. '503': description: Server is not ready to handle the request. operationId: getCompaniesWithPagination x-stoplight: id: hted2oapldhx4 description: "Returns a list of companies in an account.\r\n\r\nYou can also use this endpoint to filter out the list of companies by setting the filter parameters.\r\n\r\nNote that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects." parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'Specifies the region where your request should be routed. If not set, the request is routed automatically, which may result in a slight increase in latency. Possible values: US, EMEA, AUS, CAN, DEU, IND, JPN, GBR. For a complete list of supported regions, see the Regions page.' - schema: type: string in: header name: User-Id description: 'The ID of a user on whose behalf your request is acting. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId). Note that this header is required for Account Admin POST, PATCH, and DELETE endpoints if you want to use a 2-legged authentication context. This header is optional for Account Admin GET endpoints.' - schema: type: string in: query name: 'filter[name]' description: 'Filter companies by name. Can be a partial match based on the value of filterTextMatch provided. Max length: 255' - schema: type: string in: query name: 'filter[trade]' description: 'Filter companies by trade. Can be a partial match based on the value of filterTextMatch provided. Max length: 255' - schema: type: string in: query name: 'filter[erpId]' description: 'Filter companies by ERP Id. Can be a partial match based on the value of filterTextMatch provided. Max length: 255' - schema: type: string in: query name: 'filter[taxId]' description: 'Filter companies by tax Id. Can be a partial match based on the value of filterTextMatch provided. Max length: 255' - schema: type: string in: query name: 'filter[updatedAt]' description: 'Filter companies by updated at date range. The range must be specified with dates in an ISO-8601 format with time required. The start and end dates of the range should be separated by .. One of the dates in the range may be omitted. For example, to get everything on or before June 1, 2019 the range would be ..2019-06-01T23:59:59.999Z. To get everything after June 1, 2019 the range would be 2019-06-01T00:00:00.000Z... Max length: 100' - schema: $ref: '#/components/schemas/companyOrFilters_internal' in: query name: orFilters description: 'List of filtered fields to apply an “or” operator. Valid list of fields are erpId, name, taxId, trade, updatedAt.' - schema: $ref: '#/components/schemas/filterTextMatch' in: query name: filterTextMatch description: 'Defines how text-based filters should match results. Possible values: contains (default) – Returns results where the text appears anywhere in the field. startsWith – Matches only if the field starts with the given value. endsWith – Matches only if the field ends with the given value. equals – Matches only if the field is an exact match.' - schema: $ref: '#/components/schemas/filterCompanySort_internal' in: query name: sort description: 'The list of fields to sort by. When multiple fields are listed the later property is used to sort the resources where the previous fields have the same value. Each property can be followed by a direction modifier of either asc (ascending) or desc (descending). If no direction is specified then asc is assumed. Valid fields for sorting are name, trade, erpId, taxId, status, createdAt, updatedAt, projectSize and userSize. Default sort is name.' - schema: $ref: '#/components/schemas/filterCompanyFields_internal' in: query name: fields description: 'List of fields to return in the response. Defaults to all fields. Valid list of fields are accountId, name, trade, addresses, websiteUrl, description, erpId, taxId, imageUrl, status, createdAt, updatedAt, projectSize, userSize and originalName.' - schema: type: integer in: query name: limit description: 'The maximum number of records per request. Default: 20. Minimum: 1, Maximum: 200. If a value greater than 200 is provided, only 200 records are returned.' - schema: type: integer in: query name: offset description: 'The record number to start returning results from, used for pagination. For example, if limit=20 and offset=20, the request retrieves the second page of results.' security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] '/construction/admin/v1/accounts/{accountId}/users/{userId}/products': parameters: - schema: type: string name: accountId in: path required: true description: 'The ID of the ACC account that contains the project being created or the projects being retrieved. This corresponds to the hub ID in the Data Management API. To convert a hub ID into an account ID, remove the “b." prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' - schema: type: string name: userId in: path required: true description: The ID of the user. To find the ID call GET users. You can use either the ACC ID (id) or the Autodesk ID (autodeskId). get: summary: Get user products tags: - Account Users responses: '200': description: A list of products associated with the user content: application/json: schema: $ref: '#/components/schemas/ProductsPage' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Request has not been applied because it lacks valid authentication credentials for the target resource. '403': description: The server understood the request but refuses to authorize it. '404': description: The resource could not be found. '406': description: The server cannot produce a response matching the list of acceptable values defined in the request. '410': description: Access to the target resource is no longer available. '429': description: User has sent too many requests in a given amount of time. '500': description: An unexpected error occurred on the server. '503': description: Server is not ready to handle the request. operationId: getUserProducts x-stoplight: id: snwomaq8zrxrf description: "Returns a list of ACC products the user is associated with in their assigned projects.\r\n\r\nOnly account administrators can call this endpoint.\r\n\r\nNote that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects." security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'Specifies the region where your request should be routed. If not set, the request is routed automatically, which may result in a slight increase in latency. Possible values: US, EMEA. For a complete list of supported regions, see the Regions page.' - schema: type: string in: header name: User-Id description: 'The ID of a user on whose behalf your request is acting. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId). Note that this header is required for Account Admin POST, PATCH, and DELETE endpoints if you want to use a 2-legged authentication context. This header is optional for Account Admin GET endpoints.' - schema: $ref: '#/components/schemas/filterID' in: query name: 'filter[projectId]' description: A list of project IDs. Only results where the user is associated with one or more of the specified projects are returned. - schema: $ref: '#/components/schemas/filterProductKey_internal' in: query name: 'filter[key]' description: 'Filters the list of products by product key — a machine-readable identifier for an ACC product (such as docs, build, or cost). You can specify one or more keys to return only those products the user is associated with. Example: filter[key]=docs,build Possible values: accountAdministration, autoSpecs, build, buildingConnected, capitalPlanning, cloudWorksharing, cost, designCollaboration, docs, financials, insight, modelCoordination, projectAdministration, takeoff, and workshopxr.' - schema: $ref: '#/components/schemas/filterProductField_internal' in: query name: fields description: 'List of fields to return in the response. Defaults to all fields. Possible values: projectIds, name and icon.' - schema: $ref: '#/components/schemas/filterProductSort_internal' in: query name: sort description: 'The list of fields to sort by. Each property can be followed by a direction modifier of either asc (ascending) or desc (descending). The default is asc. Possible values: name. Default is the order in database.' - schema: type: integer in: query name: limit description: 'The maximum number of records to return in the response. Default: 20 Minimum: 1 Maximum: 200 (If a larger value is provided, only 200 records are returned)' - schema: type: integer in: query name: offset description: 'The index of the first record to return. Used for pagination in combination with the limit parameter. Example: limit=20 and offset=40 returns records 41–60.' '/construction/admin/v1/accounts/{accountId}/users/{userId}/roles': parameters: - schema: type: string name: accountId in: path required: true description: 'The ID of the ACC account that contains the project being created or the projects being retrieved. This corresponds to the hub ID in the Data Management API. To convert a hub ID into an account ID, remove the “b." prefix. For example, a hub ID of b.c8b0c73d-3ae9 translates to an account ID of c8b0c73d-3ae9.' - schema: type: string name: userId in: path required: true description: The ID of the user. To find the ID call GET users. You can use either the ACC ID (id) or the Autodesk ID (autodeskId). get: summary: Get user roles tags: - Account Users responses: '200': description: A list of requested roles associated with the user content: application/json: schema: $ref: '#/components/schemas/RolesPage' '400': description: The request could not be understood by the server due to malformed syntax. '401': description: Request has not been applied because it lacks valid authentication credentials for the target resource. '403': description: The server understood the request but refuses to authorize it. '404': description: The resource could not be found. '406': description: The server cannot produce a response matching the list of acceptable values defined in the request. '410': description: Access to the target resource is no longer available. '429': description: User has sent too many requests in a given amount of time. '500': description: An unexpected error occurred on the server. '503': description: Server is not ready to handle the request. operationId: getUserRoles x-stoplight: id: cgulon93y268q description: "Returns the roles assigned to a specific user across the projects they belong to.\r\n\r\nOnly users with account admin permissions can call this endpoint. To verify a user’s permissions, call GET users.\r\n\r\nNote that this endpoint is compatible with both BIM 360 and Autodesk Construction Cloud (ACC) projects." security: - 2-legged: [] - 3-legged-implicit: [] - 3-legged: [] parameters: - schema: $ref: '#/components/schemas/Region' in: header name: Region description: 'Specifies the region where your request should be routed. If not set, the request is routed automatically, which may result in a slight increase in latency. Possible values: US, EMEA. For a complete list of supported regions, see the Regions page.' - schema: type: string in: header name: User-Id description: 'The ID of a user on whose behalf your request is acting. Your app has access to all users specified by the administrator in the SaaS integrations UI. Provide this header value to identify the user to be affected by the request. You can use either the user’s ACC ID (id), or their Autodesk ID (autodeskId). Note that this header is required for Account Admin POST, PATCH, and DELETE endpoints if you want to use a 2-legged authentication context. This header is optional for Account Admin GET endpoints.' - schema: $ref: '#/components/schemas/filterID' in: query name: 'filter[projectId]' description: A list of project IDs. Only results where the user is associated with one or more of the specified projects are returned. - schema: $ref: '#/components/schemas/filterRoleStatus_internal' in: query name: 'filter[status]' description: 'Filters roles by their status. Accepts one or more of the following values: active – The role is currently in use. inactive – The role has been removed or is no longer in use.' - schema: type: string in: query name: 'filter[name]' description: 'Filters roles by name. By default, this performs a partial match (case-insensitive). You can control how the match behaves by using the filterTextMatch parameter. For example, to match only names that start with (startsWith), end with (endsWith), or exactly equal (equals) the provided value.' - schema: $ref: '#/components/schemas/filterTextMatch' in: query name: filterTextMatch description: 'Specifies how text-based filters should match values in supported fields. This parameter can be used in any endpoint that supports text-based filtering (e.g., filter[name], filter[jobNumber], filter[companyName], etc.). Possible values: contains (default) – Matches if the field contains the specified text anywhere startsWith – Matches if the field starts with the specified text endsWith – Matches if the field ends with the specified text equals – Matches only if the field exactly matches the specified text Matching is case-insensitive. Wildcards and regular expressions are not supported.' - schema: $ref: '#/components/schemas/filterRoleField_internal' in: query name: fields description: 'A comma-separated list of response fields to include. Defaults to all fields if not specified. Use this parameter to reduce the response size by retrieving only the fields you need. Possible values: projectIds – Projects where the user holds this role name – Role name status – Role status (active or inactive) key – Internal key used to translate the role name createdAt – Timestamp when the role was created updatedAt – Timestamp when the role was last updated' - schema: $ref: '#/components/schemas/filterRoleSort_internal' in: query name: sort description: 'Sorts the results by one or more fields. Each field can be followed by a direction modifier: asc – Ascending order (default) desc – Descending order Possible values: name, createdAt, updatedAt. Default sort: name asc Example: sort=name,updatedAt desc' - schema: type: integer in: query name: limit description: 'The maximum number of records to return in the response. Default: 20 Minimum: 1 Maximum: 200 (If a larger value is provided, only 200 records are returned)' - schema: type: integer in: query name: offset description: 'The index of the first record to return. Used for pagination in combination with the limit parameter. Example: limit=20 and offset=40 returns records 41–60.' components: schemas: ProjectsPage: title: Projects x-stoplight: id: ikvjx87zn5n72 type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array description: The requested page of projects. items: $ref: '#/components/schemas/Project' Project: title: Project x-stoplight: id: ebkpy57pcvey6 type: object properties: id: type: string description: The internally generated ID for the project. name: type: string description: |- The name of the project. Max length: 255 x-stoplight: id: 6cf9wq5ozzjck startDate: type: string description: 'The estimated start date for the project, in ISO 8601 format.' x-stoplight: id: qxtctrcqpzdim endDate: type: string x-stoplight: id: 0wy8z5fu7edd3 description: 'The estimated end date for the project, in ISO 8601 format.' type: description: The type of the project. x-stoplight: id: 0rmvamrt2vu0p type: string classification: type: string description: 'The project’s purpose. Possible values: production, template, component, sample' x-stoplight: id: la722kcrq302p projectValue: type: object description: 'The value of the project. When updating the project value, both the value and currency parameters are required.' x-stoplight: id: 7jyuuuw47s1zg status: type: string description: The status of the project. x-stoplight: id: gr9ymnwepgsvy jobNumber: type: string description: |- A job identifier that’s defined for the project by the user. This ID was defined when the project was created. Max length: 100 addressLine1: type: string description: |- Address line 1 for the project. Max length: 255 addressLine2: type: string x-stoplight: id: 1upgay7epgz9b description: |- Address line 2 for the project. Max length: 255 city: type: string x-stoplight: id: 0oc4qp1v0ftdm description: The city in which the project is located. stateOrProvince: type: string x-stoplight: id: ubo3fqfnmgqug description: The state or province in which the project is located. Only valid state/province names and ISO 3166-1 alpha-2 codes is accepted. The provided state or province must exist in the country of the project. postalCode: type: string x-stoplight: id: 5t24tmhaqskus description: The zip or postal code in which the project is located. country: type: string x-stoplight: id: xg4z9ewblj1w5 description: The country in which the project is located. Only valid country names and ISO 3166-1 alpha-2 codes is accepted. latitude: type: string x-stoplight: id: qsply44us8h4h description: The latitude of the location of the project. longitude: type: string x-stoplight: id: zp562dse6o7hj description: The longitude of the location of the project. timezone: type: string x-stoplight: id: o53ui6vd71sgp description: The time zone in which the project is located. Note that this field can be NULL. constructionType: type: string x-stoplight: id: f8bnng42rt1bj description: 'The construction type of the project. Following is a list of recommended values; however, any value is accepted.' deliveryMethod: type: string x-stoplight: id: 6bswlp8p3pzsa description: 'The delivery method of the project. Following is a list of recommended values; however, any value is accepted.' contractType: type: string x-stoplight: id: m9xai1gdvbprg description: 'The contract type of the project. Following is a list of recommended values; however, any value is accepted.' currentPhase: type: string x-stoplight: id: 5k6oorhq27hxk description: 'The current phase of the project. Following is a list of recommended values; however, any value is accepted.' businessUnitId: type: string x-stoplight: id: ww05qb8kr01ru description: The ID of the business unit that the project is associated with. lastSignIn: type: string x-stoplight: id: im38ovifkrbyv description: The timestamp of the last time someone signed into the project. imageUrl: type: string x-stoplight: id: 8d45mnflzgs33 description: The URL of the project image. thumbnailImageUrl: type: string x-stoplight: id: pscimqfva5dqw description: The URL of the project thumbnail image. createdAt: type: string x-stoplight: id: h4j1z55w3l122 description: 'The timestamp when the project was created, in ISO 8601 format.' updatedAt: type: string x-stoplight: id: wxbzhsi71d8hl description: 'The timestamp when the project was last updated, in ISO 8601 format. This reflects only changes to the project fields and not changes to any resources in the project.' memberGroupId: type: string x-stoplight: id: 8v9h1l147em3f description: Not relevant adminGroupId: type: string x-stoplight: id: mc5b6njjbon60 description: Not relevant accountId: type: string x-stoplight: id: ngfv3tuq4xk65 description: The ID of the account the project is associated with. sheetCount: type: integer x-stoplight: id: r58ypjbag6lil description: The total number of sheets associated with the project. products: type: array x-stoplight: id: 15j7grna78zar description: An array of the product objects associated with the project. items: x-stoplight: id: qv9mwsm0079v3 type: object platform: type: string x-stoplight: id: l2bslup34ygq3 description: The APS platform that the project belongs to. companyCount: type: integer x-stoplight: id: hurzujkff3e2j description: The total number of companies associated with the project. memberCount: type: integer x-stoplight: id: 4n7prnedw1mqu description: The total number of members on the project. templateId: type: string x-stoplight: id: zpt9et6ahhjj8 description: The ID of the project that was used as a template to create this project. ProjectPayload: title: ProjectPayload x-stoplight: id: ie1rcbkmjt2yc type: object properties: name: type: string description: |- The name of the project. Max length: 255 x-stoplight: id: 6cf9wq5ozzjck startDate: type: string description: 'The estimated start date for the project, in ISO 8601 format.' x-stoplight: id: qxtctrcqpzdim endDate: type: string x-stoplight: id: 0wy8z5fu7edd3 description: 'The estimated end date for the project, in ISO 8601 format.' type: description: The type of the project. x-stoplight: id: 0rmvamrt2vu0p type: string classification: $ref: '#/components/schemas/classification' description: 'The project’s purpose. ' x-stoplight: id: la722kcrq302p projectValue: type: object description: 'The value of the project. When updating the project value, both the value and currency parameters are required.' x-stoplight: id: 7jyuuuw47s1zg properties: value: type: integer x-stoplight: id: uc6040iee54lw description: The estimated value or cost of the project based on the currency specified in the currency field. The default value is 0. currency: $ref: '#/components/schemas/currency' x-stoplight: id: 3bhkzguqw0sv3 description: 'The currency of the project value for the project. Default value: USD.' jobNumber: type: string description: |- A job identifier that’s defined for the project by the user. This ID was defined when the project was created. Max length: 100 addressLine1: type: string description: |- Address line 1 for the project. Max length: 255 addressLine2: type: string x-stoplight: id: 1upgay7epgz9b description: |- Address line 2 for the project. Max length: 255 city: type: string x-stoplight: id: 0oc4qp1v0ftdm description: The city in which the project is located. stateOrProvince: type: string x-stoplight: id: ubo3fqfnmgqug description: The state or province in which the project is located. Only valid state/province names and ISO 3166-1 alpha-2 codes is accepted. The provided state or province must exist in the country of the project. postalCode: type: string x-stoplight: id: 5t24tmhaqskus description: The zip or postal code in which the project is located. country: type: string x-stoplight: id: xg4z9ewblj1w5 description: The country in which the project is located. Only valid country names and ISO 3166-1 alpha-2 codes is accepted. latitude: type: string x-stoplight: id: qsply44us8h4h description: The latitude of the location of the project. longitude: type: string x-stoplight: id: zp562dse6o7hj description: The longitude of the location of the project. timezone: $ref: '#/components/schemas/timezone' x-stoplight: id: o53ui6vd71sgp description: The time zone in which the project is located. Note that this field can be NULL. constructionType: type: string x-stoplight: id: f8bnng42rt1bj description: 'The construction type of the project. Following is a list of recommended values; however, any value is accepted.' deliveryMethod: type: string x-stoplight: id: 6bswlp8p3pzsa description: 'The delivery method of the project. Following is a list of recommended values; however, any value is accepted.' contractType: type: string x-stoplight: id: m9xai1gdvbprg description: 'The contract type of the project. Following is a list of recommended values; however, any value is accepted.' currentPhase: type: string x-stoplight: id: 5k6oorhq27hxk description: 'The current phase of the project. Following is a list of recommended values; however, any value is accepted.' businessUnitId: type: string x-stoplight: id: ww05qb8kr01ru description: The ID of the business unit that the project is associated with. sheetCount: type: integer x-stoplight: id: r58ypjbag6lil description: The total number of sheets associated with the project. products: type: array x-stoplight: id: 15j7grna78zar description: An array of the product objects associated with the project. items: x-stoplight: id: qv9mwsm0079v3 type: string platform: $ref: '#/components/schemas/platform' x-stoplight: id: l2bslup34ygq3 description: 'The APS platform that the project belongs to. Possible values: acc, bim360' companyCount: type: integer x-stoplight: id: hurzujkff3e2j description: The total number of companies associated with the project. memberCount: type: integer x-stoplight: id: 4n7prnedw1mqu description: The total number of members on the project. template: type: object x-stoplight: id: 24muiuk2wr82k description: |- Information about a project in the current user’s account that is configured as a template from which to copy products and settings when creating a new project: If you include this object in a POST accounts/:accountId/projects request, the cloned project’s products and settings will match those of the template project. If you omit this object from a POST accounts/:accountId/projects request, all of the current ACC account’s products are added to the cloned project and activated. properties: projectId: type: string x-stoplight: id: zwze88rqhbow0 description: The ID of a project template in the current ACC account from which to clone the new project and copy products and settings. options: type: object x-stoplight: id: wigltykwfys3w description: Information about what to include when cloning a project template. properties: field: type: object x-stoplight: id: jdnmtzcvswyqk description: Project template options specific to classic field. properties: includeCompanies: type: boolean x-stoplight: id: h6w5dse4kw4vu description: |- Indicates whether to include company data when copying from the project template. true: Include company data. false: Exclude company data. includeLocations: type: boolean x-stoplight: id: zrg9252udrk4x description: |- Indicates whether to include location data when copying from the template project. true: Include location data. false: Exclude location data. required: - projectId required: - name - type ProjectPatch: title: ProjectPatch x-stoplight: id: g4k3if9lta3pg type: object properties: id: type: string description: Project ID account_id: type: string x-stoplight: id: e67zvdyuagrvb description: Account ID name: type: string x-stoplight: id: dmzvvk6gp4fvg description: Name of the project start_date: type: string x-stoplight: id: xn0vpzsk6nrpn description: |- The starting date of a project; must be earlier than end_date Format: YYYY-MM-DD end_date: type: string x-stoplight: id: 8k65nul995k5g description: |- The ending date of a project; must be later than start_date Format: YYYY-MM-DD project_type: type: string x-stoplight: id: 0ougx4e12wc5e description: The type of project; accepts preconfigured and customized project types value: type: number x-stoplight: id: 3gfeukdzeddnr description: Monetary value of the project currency: type: string x-stoplight: id: e1jzwyjpobyt8 description: Currency for project value status: x-stoplight: id: gruqhoco7k1hr description: The status of project. type: string job_number: type: string x-stoplight: id: x97wzdzwxscc8 description: Project job number to connect a BIM 360 project to project or job in a financial or ERP system. address_line_1: type: string x-stoplight: id: be7zse4sz643m description: Project address line 1 address_line_2: type: string x-stoplight: id: unu5zecux1alc description: Project address line 2 city: type: string x-stoplight: id: mcn6w0lvgnp20 description: City in which project is located state_or_province: type: string x-stoplight: id: w39x7lnnh9myp description: State or province in which project is located postal_code: type: string x-stoplight: id: owsyshcr8hvna description: Postal code for the project location country: type: string x-stoplight: id: 8p08o8arqn17l description: Country for this project business_unit_id: type: string x-stoplight: id: 17xu7kyhn7del description: The business unit ID of this project timezone: type: string x-stoplight: id: qs32hyvg8ajfy description: Time zone for this project language: x-stoplight: id: g6dvm8dmqd5yw description: Language of the project; applicable to the BIM 360 Field service only type: string construction_type: x-stoplight: id: beot2pj6n3azw description: Type of construction type: string contract_type: x-stoplight: id: ovt9kdgv1cqxh description: Contract Type for your project type: string last_sign_in: type: string x-stoplight: id: 10g0wn1qosciu description: 'Timestamp of the last sign in, YYYY-MM-DDThh:mm:ss.sssZ format' Company: title: Company x-stoplight: id: a07ikbbdxen99 type: object properties: id: type: string description: Company ID account_id: type: string x-stoplight: id: p5xb64wnh4wmx description: Account ID name: type: string x-stoplight: id: iet5cvhxxlpk0 description: Company name should be unique under an account trade: type: string x-stoplight: id: 1b2guw2drwxjr description: Trade type based on specialization address_line_1: type: string x-stoplight: id: 12voppe6n4dem description: Company address line 1 address_line_2: type: string x-stoplight: id: ovz2wunnvpu7r description: Company address line 2 city: type: string x-stoplight: id: cxd0ahqxpo1en description: City in which company is located state_or_province: type: string x-stoplight: id: 3z6lmdqunni69 description: State or province in which company is located postal_code: type: string x-stoplight: id: mrqr2ey51mfag description: Postal code for the company location country: type: string x-stoplight: id: q8j06kajtg0v8 description: Country for this company phone: type: string x-stoplight: id: x5siwgk3npdvx description: Business phone number for the company website_url: type: string x-stoplight: id: lubzf7q51z7o8 description: Company website description: type: string x-stoplight: id: i6e14q3h6b0sx description: Short description or overview for company erp_id: type: string x-stoplight: id: jz2sci73ene74 description: Used to associate a company in BIM 360 with the company data in an ERP system tax_id: type: string x-stoplight: id: k6ponb7ozqs5j description: Used to associate a company in BIM 360 with the company data from public and industry sources CompanyImport: title: CompanyImportResponse x-stoplight: id: w1u6pqi8dlrys type: object properties: success: type: integer x-stoplight: id: vfh38q2zhm7vr description: Import success company count failure: type: integer x-stoplight: id: wbnrw0ceazwkh description: Import failure company count success_items: type: array x-stoplight: id: b91r3bdiu4916 description: Array of company objects that were successfully imported items: $ref: '#/components/schemas/Company' x-stoplight: id: yreisjgu8c84e failure_items: type: array x-stoplight: id: spdgokc6tgfr3 description: 'Array of company objects that failed to import, along with content and error information' items: $ref: '#/components/schemas/Company' x-stoplight: id: h3qbrhrr4tpef description: '' CompanyPayload: title: CompanyPayload x-stoplight: id: z8zjhylvl5py0 type: object properties: name: type: string x-stoplight: id: iet5cvhxxlpk0 description: Company name should be unique under an account trade: $ref: '#/components/schemas/trade' x-stoplight: id: 1b2guw2drwxjr description: Trade type based on specialization address_line_1: type: string x-stoplight: id: 12voppe6n4dem description: Company address line 1 address_line_2: type: string x-stoplight: id: ovz2wunnvpu7r description: Company address line 2 city: type: string x-stoplight: id: cxd0ahqxpo1en description: City in which company is located state_or_province: type: string x-stoplight: id: 3z6lmdqunni69 description: State or province in which company is located postal_code: type: string x-stoplight: id: mrqr2ey51mfag description: Postal code for the company location country: type: string x-stoplight: id: q8j06kajtg0v8 description: Country for this company phone: type: string x-stoplight: id: x5siwgk3npdvx description: Business phone number for the company website_url: type: string x-stoplight: id: lubzf7q51z7o8 description: Company website description: type: string x-stoplight: id: i6e14q3h6b0sx description: Short description or overview for company erp_id: type: string x-stoplight: id: jz2sci73ene74 description: Used to associate a company in BIM 360 with the company data in an ERP system tax_id: type: string x-stoplight: id: k6ponb7ozqs5j description: Used to associate a company in BIM 360 with the company data from public and industry sources required: - name - trade CompanyPatchPayload: title: CompanyPatchPayload x-stoplight: id: 3w00n26opiju3 type: object properties: name: type: string x-stoplight: id: iet5cvhxxlpk0 description: Company name should be unique under an account trade: $ref: '#/components/schemas/trade' x-stoplight: id: 1b2guw2drwxjr description: Trade type based on specialization address_line_1: type: string x-stoplight: id: 12voppe6n4dem description: Company address line 1 address_line_2: type: string x-stoplight: id: ovz2wunnvpu7r description: Company address line 2 city: type: string x-stoplight: id: cxd0ahqxpo1en description: City in which company is located state_or_province: type: string x-stoplight: id: 3z6lmdqunni69 description: State or province in which company is located postal_code: type: string x-stoplight: id: mrqr2ey51mfag description: Postal code for the company location country: type: string x-stoplight: id: q8j06kajtg0v8 description: Country for this company phone: type: string x-stoplight: id: x5siwgk3npdvx description: Business phone number for the company website_url: type: string x-stoplight: id: lubzf7q51z7o8 description: Company website description: type: string x-stoplight: id: i6e14q3h6b0sx description: Short description or overview for company erp_id: type: string x-stoplight: id: jz2sci73ene74 description: Used to associate a company in BIM 360 with the company data in an ERP system tax_id: type: string x-stoplight: id: k6ponb7ozqs5j description: Used to associate a company in BIM 360 with the company data from public and industry sources ProjectCompanies: title: Companies x-stoplight: id: 1ltchlash196q type: object properties: id: type: string description: Company ID account_id: type: string x-stoplight: id: p5xb64wnh4wmx description: Account ID project_id: type: string x-stoplight: id: p5xb64wnh4wmx description: Project ID name: type: string x-stoplight: id: iet5cvhxxlpk0 description: Company name should be unique under an account trade: type: string x-stoplight: id: 1b2guw2drwxjr description: Trade type based on specialization address_line_1: type: string x-stoplight: id: 12voppe6n4dem description: Company address line 1 address_line_2: type: string x-stoplight: id: ovz2wunnvpu7r description: Company address line 2 city: type: string x-stoplight: id: cxd0ahqxpo1en description: City in which company is located state_or_province: type: string x-stoplight: id: 3z6lmdqunni69 description: State or province in which company is located postal_code: type: string x-stoplight: id: mrqr2ey51mfag description: Postal code for the company location country: type: string x-stoplight: id: q8j06kajtg0v8 description: Country for this company phone: type: string x-stoplight: id: x5siwgk3npdvx description: Business phone number for the company website_url: type: string x-stoplight: id: lubzf7q51z7o8 description: Company website description: type: string x-stoplight: id: i6e14q3h6b0sx description: Short description or overview for company erp_id: type: string x-stoplight: id: jz2sci73ene74 description: Used to associate a company in BIM 360 with the company data in an ERP system tax_id: type: string x-stoplight: id: k6ponb7ozqs5j description: Used to associate a company in BIM 360 with the company data from public and industry sources member_group_id: type: string x-stoplight: id: dgnf1q93x7ydp description: The Autodesk ID of the company; used to identify which company is assigned to an RFI or Issue. classification: title: classification x-stoplight: id: kiltb9wsm9iye type: string enum: - production - template - component - sample status: title: status x-stoplight: id: 7imcqgahx8744 type: string enum: - active - pending - archived - suspended status_internal: title: status_internal type: array items: $ref: '#/components/schemas/status' x-stoplight: id: 3sxoqp01jo0t2 fields: title: fields x-stoplight: id: 2u11626lmta32 type: string enum: - accountId - addressLine1 - addressLine2 - businessUnitId - city - companyCount - constructionType - country - createdAt - deliveryMethod - endDate - imageUrl - jobNumber - lastSignIn - latitude - longitude - memberCount - name - platform - postalCode - products - projectValue - sheetCount - startDate - stateOrProvince - status - thumbnailImageUrl - timezone - type - updatedAt fields_internal: title: fields_internal x-stoplight: id: gllpnqude53mp type: array items: $ref: '#/components/schemas/fields' x-stoplight: id: eak8q4id1p2i3 platform: title: platform x-stoplight: id: w4j4h1zy6fji2 type: string enum: - acc - bim360 User: title: User x-stoplight: id: fx3z9ao4dnpxy type: object properties: id: type: string description: BIM 360 user ID account_id: type: string description: Account ID role: description: The role of the user in the account. New user should be account_user only. type: string status: description: Status of the user in the system. A new account user is always not_invited. type: string company_id: type: string description: The user’s default company ID in BIM 360 company_name: type: string description: The name of the user’s default company name in BIM 360 last_sign_in: type: string description: 'Timestamp of the last sign in, YYYY-MM-DDThh:mm:ss.sssZ format' email: type: string description: 'User’s email ' name: type: string description: Default display name nickname: type: string description: Nick name for user first_name: type: string description: User’s first name last_name: type: string description: User’s last name uid: type: string description: User’s Autodesk ID image_url: type: string description: URL for user’s profile image address_line_1: type: string description: User’s address line 1 address_line_2: type: string description: User’s address line 2 city: type: string description: City in which user is located state_or_province: type: string description: State or province in which user is located postal_code: type: string description: Postal code for the user’s location country: type: string description: Country for this user phone: type: string description: Contact phone number for the user company: type: string description: Company information from the Autodesk user profile job_title: type: string description: User’s job title industry: type: string description: Industry information for user about_me: type: string description: Short description about the user created_at: type: string description: 'YYYY-MM-DDThh:mm:ss.sssZ format' updated_at: type: string description: 'YYYY-MM-DDThh:mm:ss.sssZ format' UserPayload: title: UserPayload x-stoplight: id: xilzd946u5je1 type: object properties: company_id: type: string description: The user’s default company ID in BIM 360 email: type: string description: 'User’s email ' name: type: string description: Default display name nickname: type: string description: Nick name for user first_name: type: string description: User’s first name last_name: type: string description: User’s last name image_url: type: string description: URL for user’s profile image address_line_1: type: string description: User’s address line 1 address_line_2: type: string description: User’s address line 2 city: type: string description: City in which user is located state_or_province: type: string description: State or province in which user is located postal_code: type: string description: Postal code for the user’s location country: type: string description: Country for this user phone: type: string description: Contact phone number for the user company: type: string description: Company information from the Autodesk user profile job_title: type: string description: User’s job title industry: type: string description: Industry information for user about_me: type: string description: Short description about the user required: - email UserImport: title: UserImportResponse x-stoplight: id: t8o0t7wpee7l3 type: object properties: success: type: integer x-stoplight: id: vfh38q2zhm7vr description: Import success user count failure: type: integer x-stoplight: id: wbnrw0ceazwkh description: Import failure user count success_items: type: array x-stoplight: id: b91r3bdiu4916 description: Array of user objects that were successfully imported items: $ref: '#/components/schemas/User' x-stoplight: id: yreisjgu8c84e failure_items: type: array x-stoplight: id: spdgokc6tgfr3 description: 'Array of user objects that failed to import, along with content and error information' items: $ref: '#/components/schemas/User' x-stoplight: id: h3qbrhrr4tpef UserPatchPayload: title: UserPatchPayload x-stoplight: id: xw8ty4k0es17i type: object properties: status: $ref: '#/components/schemas/userPatchStatus' x-stoplight: id: n6e75bp9t1fl3 description: New status to set the user to (only if not currently pending or not_invited) company_id: type: string x-stoplight: id: f3n7hx18s62dv description: The user’s default company ID in BIM 360 userPatchStatus: title: userPatchStatus x-stoplight: id: vy3l7dr8yvvt4 type: string enum: - active - inactive ProjectUsersPage: title: ProjectUsers x-stoplight: id: f584b87ecf8ca type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array description: The requested page of project users. items: $ref: '#/components/schemas/ProjectUser' ProjectUser: title: ProjectUser x-stoplight: id: yr7m0t04g7srf type: object properties: email: type: string x-stoplight: id: 4l126as65h226 description: |- The email of the user. Max length: 255 id: type: string description: The ACC ID of the user. name: type: string description: The full name of the user. firstName: type: string description: |- The user’s first name. This data syncs from the user’s Autodesk profile. Max length: 255 lastName: type: string description: |- The user’s last name. This data syncs from the user’s Autodesk profile. Max length: 255 autodeskId: type: string description: |- The ID of the user’s Autodesk profile. Max length: 255 analyticsId: type: string description: Not relevant addressLine1: type: string description: |- The user’s address line 1. This data syncs from the user’s Autodesk profile. Max length: 255 addressLine2: type: string description: |- The user’s address line 2. This data syncs from the user’s Autodesk profile. Max length: 255 city: type: string description: |- The User’s city. This data syncs from the user’s Autodesk profile. Max length: 255 stateOrProvince: type: string description: |- The state or province of the user. The accepted values here change depending on which country is provided. This data syncs from the user’s Autodesk profile. Max length: 255 postalCode: type: string description: |- The zip or postal code of the user. This data syncs from the user’s Autodesk profile. Max length: 255 country: type: string description: |- The user’s country. This data syncs from the user’s Autodesk profile. Max length: 255 imageUrl: type: string description: |- The URL of the user’s avatar. This data syncs from the user’s Autodesk profile. Max length: 255 phone: description: The user’s phone number. This data syncs from the user’s Autodesk profile. type: object properties: number: type: string x-stoplight: id: 9jn34var2c9nu description: User’s phone number phoneType: type: string x-stoplight: id: i4870b3euojc3 description: The user’s phone type. extension: type: string x-stoplight: id: wz1h6mlxohgqp description: User’s phone extension. jobTitle: type: string description: |- The user’s job title. This data syncs from the user’s Autodesk profile. Max length: 255 industry: type: string description: |- The industry the user works in. This data syncs from the user’s Autodesk profile. Max length: 255 aboutMe: type: string description: |- A short bio about the user. This data syncs from the user’s Autodesk profile. Max length: 255 accessLevels: description: Flags that identify a returned user’s access levels in the account or project. type: object properties: accountAdmin: type: boolean x-stoplight: id: uit3quf92pt7c description: Indicates whether the user is an account administrator for the account. projectAdmin: type: boolean x-stoplight: id: 19r2u8did6fgi description: Indicates whether the user is a project administrator for the project. executive: type: boolean x-stoplight: id: vwasqda2gcmm0 description: Indicates whether the user is an executive in the account. addedOn: type: string description: The timestamp when the user was first given access to any product on the project. updatedAt: type: string description: 'The timestamp when the project user was last updated, in ISO 8601 format.' companyId: type: string description: 'The ID of the company that the user is representing in the project. To obtain a list of all company IDs associated with a project, call GET projects/:projectId/companies.' companyName: type: string description: |- The name of the company to which the user belongs. Max length: 255 roleIds: type: array items: type: string description: A list of IDs of the roles that the user belongs to in the project. roles: description: A list of the role IDs and names that are associated with the user in the project. type: array items: type: object properties: id: type: string x-stoplight: id: k4i4pyorywmgu description: The ID of a role that the user belongs to in the project. name: type: string x-stoplight: id: 06k3jj0ewbula description: The name of a role that the user belongs to in the project. status: type: string description: 'The status of the user in the project. A pending user could be waiting for their products to activate, or the user hasn’t accepted an email to create an account with Autodesk.' products: type: array items: type: object x-stoplight: id: hasrcy0zzx3bm properties: key: type: string x-stoplight: id: wkmu7n556lqbw description: A keyword that identifies the product. access: type: string x-stoplight: id: 2hg7ktpbupezj description: The user’s type of access to the product identified by key. ProjectUserPayload: title: ProjectUserPayload x-stoplight: id: d7oxg934a3kf6 type: object properties: email: type: string x-stoplight: id: bhz1gjhsjijd7 description: |- The email address of the user. Max length: 255 companyId: type: string x-stoplight: id: qjr3ljiek0a25 description: 'The ID of the company that the user is representing in the project. To obtain a list of all company IDs associated with a project, call GET projects/:projectId/companies.' roleIds: type: array x-stoplight: id: k3j3e6w9zd7c3 description: A list of IDs of the roles that the user belongs to in the project. items: x-stoplight: id: ngp6d387c9q14 type: string products: type: array items: type: object required: - key - access properties: key: $ref: '#/components/schemas/productKeys' x-stoplight: id: wkmu7n556lqbw description: A keyword that identifies the product. access: $ref: '#/components/schemas/productAccess' x-stoplight: id: 2hg7ktpbupezj description: The user’s type of access to the product identified by key. required: - email - products ProjectUserDetails: title: ProjectUserResponse x-stoplight: id: yiq5880t5rnsf type: object properties: email: type: string x-stoplight: id: 4l126as65h226 description: |- The email of the user. Max length: 255 id: type: string description: The ACC ID of the user. name: type: string description: The full name of the user. firstName: type: string description: |- The user’s first name. This data syncs from the user’s Autodesk profile. Max length: 255 lastName: type: string description: |- The user’s last name. This data syncs from the user’s Autodesk profile. Max length: 255 autodeskId: type: string description: |- The ID of the user’s Autodesk profile. Max length: 255 analyticsId: type: string description: Not relevant addressLine1: type: string description: |- The user’s address line 1. This data syncs from the user’s Autodesk profile. Max length: 255 addressLine2: type: string description: |- The user’s address line 2. This data syncs from the user’s Autodesk profile. Max length: 255 city: type: string description: |- The User’s city. This data syncs from the user’s Autodesk profile. Max length: 255 stateOrProvince: type: string description: |- The state or province of the user. The accepted values here change depending on which country is provided. This data syncs from the user’s Autodesk profile. Max length: 255 postalCode: type: string description: |- The zip or postal code of the user. This data syncs from the user’s Autodesk profile. Max length: 255 country: type: string description: |- The user’s country. This data syncs from the user’s Autodesk profile. Max length: 255 imageUrl: type: string description: |- The URL of the user’s avatar. This data syncs from the user’s Autodesk profile. Max length: 255 phone: description: The user’s phone number. This data syncs from the user’s Autodesk profile. type: object properties: number: type: string x-stoplight: id: 9jn34var2c9nu description: User’s phone number phoneType: type: string x-stoplight: id: i4870b3euojc3 description: The user’s phone type. extension: type: string x-stoplight: id: wz1h6mlxohgqp description: User’s phone extension. jobTitle: type: string description: |- The user’s job title. This data syncs from the user’s Autodesk profile. Max length: 255 industry: type: string description: |- The industry the user works in. This data syncs from the user’s Autodesk profile. Max length: 255 aboutMe: type: string description: |- A short bio about the user. This data syncs from the user’s Autodesk profile. Max length: 255 accessLevels: description: Flags that identify a returned user’s access levels in the account or project. type: object properties: accountAdmin: type: boolean x-stoplight: id: uit3quf92pt7c description: Indicates whether the user is an account administrator for the account. projectAdmin: type: boolean x-stoplight: id: 19r2u8did6fgi description: Indicates whether the user is a project administrator for the project. executive: type: boolean x-stoplight: id: vwasqda2gcmm0 description: Indicates whether the user is an executive in the account. addedOn: type: string description: The timestamp when the user was first given access to any product on the project. updatedAt: type: string description: 'The timestamp when the project user was last updated, in ISO 8601 format.' companyId: type: string description: 'The ID of the company that the user is representing in the project. To obtain a list of all company IDs associated with a project, call GET projects/:projectId/companies.' companyName: type: string description: |- The name of the company to which the user belongs. Max length: 255 roleIds: type: array items: type: string description: A list of IDs of the roles that the user belongs to in the project. roles: description: A list of the role IDs and names that are associated with the user in the project. type: array items: type: object properties: id: type: string x-stoplight: id: k4i4pyorywmgu description: The ID of a role that the user belongs to in the project. name: type: string x-stoplight: id: 06k3jj0ewbula description: The name of a role that the user belongs to in the project. status: type: string description: 'The status of the user in the project. A pending user could be waiting for their products to activate, or the user hasn’t accepted an email to create an account with Autodesk.' products: type: array items: type: object x-stoplight: id: hasrcy0zzx3bm properties: key: type: string x-stoplight: id: wkmu7n556lqbw description: A keyword that identifies the product. access: type: string x-stoplight: id: 2hg7ktpbupezj description: The user’s type of access to the product identified by key. jobId: type: string x-stoplight: id: sykfft9q3jzuo description: Not relevant - we don’t currently support this field. ProjectUsersImportPayload: title: ProjectUsersImportPayload x-stoplight: id: 73uitwejlqc1t type: object properties: users: description: User data to import. type: array items: type: object properties: firstName: type: string description: |- The first name of the user. Max length: 255 lastName: type: string description: |- The last name of the user. Max length: 255 email: type: string x-stoplight: id: bhz1gjhsjijd7 description: |- The email address of the user. Max length: 255 companyId: type: string x-stoplight: id: qjr3ljiek0a25 description: 'The ID of the company that the user is representing in the project. To obtain a list of all company IDs associated with a project, call GET projects/:projectId/companies.' roleIds: type: array x-stoplight: id: k3j3e6w9zd7c3 description: A list of IDs of the roles that the user belongs to in the project. items: x-stoplight: id: ngp6d387c9q14 type: string products: type: array items: type: object x-stoplight: id: hasrcy0zzx3bm properties: key: $ref: '#/components/schemas/productKeys' x-stoplight: id: wkmu7n556lqbw description: A keyword that identifies the product. access: $ref: '#/components/schemas/productAccess' x-stoplight: id: 2hg7ktpbupezj description: The user’s type of access to the product identified by key. required: - key - access required: - email - products ProjectUsersImport: title: ProjectUsersImportResponse x-stoplight: id: 4vlcsf9vutqs8 type: object properties: jobId: type: string x-stoplight: id: m7smt5frycgog description: |- We don’t currently support this field, but expect to in a future release. If the response returns jobId with a valid UUID value, the user import operation was successful. ProjectUsersUpdatePayload: title: ProjectUsersUpdatePayload x-stoplight: id: 7hpr38vcbofx7 type: object properties: email: type: string x-stoplight: id: bhz1gjhsjijd7 description: |- The email address of the user. Max length: 255 companyId: type: string x-stoplight: id: qjr3ljiek0a25 description: 'The ID of the company that the user is representing in the project. To obtain a list of all company IDs associated with a project, call GET projects/:projectId/companies.' roleIds: type: array x-stoplight: id: k3j3e6w9zd7c3 description: A list of IDs of the roles that the user belongs to in the project. items: x-stoplight: id: ngp6d387c9q14 type: string products: type: array items: type: object x-stoplight: id: hasrcy0zzx3bm properties: key: $ref: '#/components/schemas/productKeys' x-stoplight: id: wkmu7n556lqbw description: A keyword that identifies the product. access: $ref: '#/components/schemas/productAccess' x-stoplight: id: 2hg7ktpbupezj description: The user’s type of access to the product identified by key. required: - key - access BusinessUnit: title: BusinessUnit x-stoplight: id: 2g2vpfiwr1evd type: object properties: id: type: string description: Business unit ID account_id: type: string x-stoplight: id: 87d5kevscjst5 description: Account ID parent_id: type: string x-stoplight: id: ripvdy2jdxt5h description: |- The ID of the parent business unit; used to configure the tree structure of business units name: type: string x-stoplight: id: e5y59vjyh9u3g description: | The name of the business unit path: type: string x-stoplight: id: y2vcp5y80gjjj description: The path of the business unit in the tree structure description: type: string x-stoplight: id: wywguzh955t9m description: The description of the business unit created_at: type: string x-stoplight: id: 4bta8t8vaq96a updated_at: type: string x-stoplight: id: epd0mv6uik60l BusinessUnits: title: BusinessUnitsResponse x-stoplight: id: bje738qyuuz2v type: object properties: business_units: type: array x-stoplight: id: n5utlu9b7jz16 items: $ref: '#/components/schemas/BusinessUnit' x-stoplight: id: 2sl170itvk70g BusinessUnitsPayload: title: BusinessUnitsPayload x-stoplight: id: vg238uncrewqq type: object properties: business_units: type: array x-stoplight: id: 9dce24721l40s items: $ref: '#/components/schemas/BusinessUnitsObject' x-stoplight: id: xmd2c1g2ax76z BusinessUnitsObject: title: BusinessUnitsObject x-stoplight: id: ofwz7wxle2i79 type: object properties: id: type: string x-stoplight: id: 1t6r79la6n8xx description: |- Business unit ID If specified and already existing, the existing business unit will be replaced with the provided attributes. If specified and not already existing, a new business unit will be created with the id. If unspecified, a new business unit will be created with a server-generated id. parent_id: type: string x-stoplight: id: vaqvh4gbvaq4i description: |- The ID of the parent business unit Note that an entire business unit hierarchy can be created by manually specifying the id attribute for each business unit and using it as appropriate in other parent_id attributes. name: type: string x-stoplight: id: vp8m48lup86mn description: The name of the business unit description: type: string x-stoplight: id: gjwcknccphtzc description: The description of the business unit required: - name Region: title: Region x-stoplight: id: 5rz8jxdpgo4zq type: string enum: - US - EMEA - AUS - CAN - DEU - IND - JPN - GBR description: |- Specifies the region where your request should be routed. Possible values are: - ``US`` - Data center for the US region. - ``EMEA`` - Data center for the European Union, Middle East, and Africa regions. - ``AUS`` - Data center for the Australia region. - ``CAN`` - Data center for the Canada region. - ``DEU`` - Data center for the Germany region. - ``IND`` - Data center for the India region. - ``JPN`` - Data center for the Japan region. - ``GBR`` - Data center for the United Kingdom region. filterClassification_internal: title: filterClassification_internal type: array items: $ref: '#/components/schemas/classification' filterPlatform_internal: title: filterPlatform_internal x-stoplight: id: 07osm8uexhmzc type: array items: $ref: '#/components/schemas/platform' x-stoplight: id: blbjael8tal1d filterType: title: filterType type: array items: type: string filterTextMatch: title: filterTextMatch x-stoplight: id: l613i9qr8h8a6 type: string enum: - contains - startsWith - endsWith - equals sort_internal: title: sort_internal type: array items: $ref: '#/components/schemas/sortBy' x-stoplight: id: rco9c6oaws4eh sortBy: title: sortBy x-stoplight: id: th8hud7fjoevd type: string enum: - name asc - startDate asc - endDate asc - type asc - status asc - jobNumber asc - constructionType asc - deliveryMethod asc - contractType asc - currentPhase asc - companyCount asc - memberCount asc - createdAt asc - updatedAt asc - name desc - startDate desc - endDate desc - type desc - status desc - jobNumber desc - constructionType desc - deliveryMethod desc - contractType desc - currentPhase desc - companyCount desc - memberCount desc - createdAt desc - updatedAt desc products: title: products x-stoplight: id: qr6chlzpjohw0 type: string enum: - build - docs - takeoff - cost - autospecs - financials - buildingConnected - capitalPlanning - accountAdministration - workshopxr - insight - projectAdministration - modelCoordination - designCollaboration - cloudWorksharing - fieldManagement - costManagement - glue - documentManagement - projectHome - assets - quantification - plan - field - projectManagement description: '' products_internal: title: products_internal x-stoplight: id: 9c80166a5fe5a type: array items: $ref: '#/components/schemas/products' x-stoplight: id: qeezmlysbidw9 productKeys: title: productKeys type: string enum: - build - docs - takeoff - cost - autoSpecs - financials - buildingConnected - capitalPlanning - accountAdministration - workshopxr - insight - projectAdministration - modelCoordination - designCollaboration - cloudWorksharing productAccess: title: productAccess x-stoplight: id: fb0367b9f7e57 type: string enum: - administrator - member - none timezone: title: timezone type: string enum: - Pacific/Honolulu - America/Juneau - America/Los_Angeles - America/Phoenix - America/Denver - America/Chicago - America/New_York - America/Indiana/Indianapolis - Pacific/Pago_Pago - Pacific/Midway - America/Tijuana - America/Chihuahua - America/Mazatlan - America/Guatemala - America/Mexico_City - America/Monterrey - America/Regina - America/Bogota - America/Lima - America/Caracas - America/Halifax - America/Guyana - America/La_Paz - America/Santiago - America/St_Johns - America/Sao_Paulo - America/Argentina/Buenos_Aires - America/Godthab - Atlantic/South_Georgia - Atlantic/Azores - Atlantic/Cape_Verde - Africa/Casablanca - Europe/Dublin - Europe/Lisbon - Europe/London - Africa/Monrovia - Etc/UTC - Europe/Amsterdam - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Budapest - Europe/Copenhagen - Europe/Ljubljana - Europe/Madrid - Europe/Paris - Europe/Prague - Europe/Rome - Europe/Sarajevo - Europe/Skopje - Europe/Stockholm - Europe/Vienna - Europe/Warsaw - Africa/Algiers - Europe/Zagreb - Europe/Athens - Europe/Bucharest - Africa/Cairo - Africa/Harare - Europe/Helsinki - Europe/Istanbul - Asia/Jerusalem - Europe/Kiev - Africa/Johannesburg - Europe/Riga - Europe/Sofia - Europe/Tallinn - Europe/Vilnius - Asia/Baghdad - Asia/Kuwait - Europe/Minsk - Africa/Nairobi - Asia/Riyadh - Asia/Tehran - Asia/Muscat - Asia/Baku - Europe/Moscow - Asia/Tbilisi - Asia/Yerevan - Asia/Kabul - Asia/Karachi - Asia/Tashkent - Asia/Kolkata - Asia/Colombo - Asia/Kathmandu - Asia/Almaty - Asia/Dhaka - Asia/Yekaterinburg - Asia/Rangoon - Asia/Bangkok - Asia/Jakarta - Asia/Novosibirsk - Asia/Shanghai - Asia/Chongqing - Asia/Hong_Kong - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Australia/Perth - Asia/Singapore - Asia/Taipei - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Irkutsk - Asia/Tokyo - Asia/Seoul - Australia/Adelaide - Australia/Darwin - Australia/Brisbane - Australia/Melbourne - Pacific/Guam - Australia/Hobart - Pacific/Port_Moresby - Australia/Sydney - Asia/Yakutsk - Pacific/Noumea - Asia/Vladivostok - Pacific/Auckland - Pacific/Fiji - Asia/Kamchatka - Asia/Magadan - Pacific/Majuro - Pacific/Guadalcanal - Pacific/Tongatapu - Pacific/Apia - Pacific/Fakaofo currency: title: currency type: string enum: - AED - AFN - ALL - AMD - ANG - AOA - ARS - AUD - AWG - AZN - BAM - BBD - BDT - BGN - BHD - BIF - BMD - BND - BOB - BOV - BRL - BSD - BTN - BWP - BYN - BYR - BZD - CAD - CDF - CHE - CHF - CHW - CLF - CLP - CNY - COP - COU - CRC - CUC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EEK - EGP - ERN - ETB - EUR - FJD - FKP - GBP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LTL - LVL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SLL - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TRL - TRY - TTD - TWD - TZS - UAH - UGX - USD - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAF - XAG - XAU - XBA - XBB - XBC - XBD - XCD - XDR - XOF - XPD - XPF - XPT - XSU - XTS - XUA - XXX - YER - ZAR - ZMW - ZWL userFields: title: userFields x-stoplight: id: 7zsag4qu2hd1k type: string enum: - name - email - firstName - lastName - autodeskId - addressLine1 - addressLine2 - city - stateOrProvince - postalCode - country - imageUrl - lastSignIn - phone - jobTitle - industry - aboutMe - createdAt - updatedAt - accessLevels - companyId - roleIds - roles - status - addedOn - products userFields_internal: title: userFields_internal type: array items: $ref: '#/components/schemas/userFields' x-stoplight: id: web6yrp57burr accessLevels: title: accessLevels x-stoplight: id: v2kbai7y3z4ls type: string enum: - accountAdmin - projectAdmin - executive accessLevels_internal: title: accessLevels_internal x-stoplight: id: wmvzmw12gsy4j type: array items: $ref: '#/components/schemas/accessLevels' x-stoplight: id: 8768wybirus40 filterAutodeskId: title: filterAutodeskId x-stoplight: id: 2avndceqj70a9 type: array items: x-stoplight: id: 3ffftrtd5ie5v type: string filterID: title: filterID type: array items: type: string filterRoleIds: title: filterRoleIds x-stoplight: id: b2vwul3iejon9 type: array items: x-stoplight: id: cjucar8u515y5 type: string userSortBy: title: userSortBy x-stoplight: id: 4pk6sj0cgqqan type: string enum: - name asc - email asc - firstName asc - lastName asc - addressLine1 asc - addressLine2 asc - city asc - companyName asc - stateOrProvince asc - status asc - phone asc - postalCode asc - country asc - addedOn asc - name desc - email desc - firstName desc - lastName desc - addressLine1 desc - addressLine2 desc - city desc - companyName desc - stateOrProvince desc - status desc - phone desc - postalCode desc - country desc - addedOn desc userSortBy_internal: title: userSortBy_internal x-stoplight: id: gtw01y7bwe28r type: array items: $ref: '#/components/schemas/userSortBy' x-stoplight: id: doc1w838c38cz orFilters: title: orFilters x-stoplight: id: hch98m33unr18 type: string enum: - id - name - email - autodeskId - status - accessLevels orFilters_internal: title: orFilters_internal x-stoplight: id: el45nd3vlwq52 type: array items: $ref: '#/components/schemas/orFilters' x-stoplight: id: xms9nyrej26w8 statusFilter: title: statusFilter x-stoplight: id: xqc12d47t2w4v type: string enum: - active - pending - deleted statusFilter_internal: title: statusFilter_internal x-stoplight: id: egjtyb75hopy5 type: array items: $ref: '#/components/schemas/statusFilter' x-stoplight: id: hcsuxuefqfyhc trade: title: trade x-stoplight: id: l2gbhaf1mw5jg type: string enum: - Architecture - Communications - Communications | Data - Concrete - Concrete | Cast-in-Place - Concrete | Precast - Construction Management - Conveying Equipment - Conveying Equipment | Elevators - Demolition - Earthwork - Earthwork | Site Excavation & Grading - Electrical - Electrical Power Generation - Electronic Safety & Security - Equipment - Equipment | Kitchen Appliances - Exterior Improvements - Exterior | Fences & Gates - Exterior | Landscaping - Exterior | Irrigation - Finishes - Finishes | Carpeting - Finishes | Ceiling - Finishes | Drywall - Finishes | Flooring - Finishes | Painting & Coating - Finishes | Tile - Fire Suppression - Furnishings - Furnishings | Casework & Cabinets - Furnishings | Countertops - Furnishings | Window Treatments - General Contractor - 'HVAC Heating, Ventilating, & Air Conditioning' - Industry-Specific Manufacturing Processing - Integrated Automation - Masonry - Material Processing & Handling Equipment - Metals - Metals | Structural Steel / Framing - Moisture Protection - Moisture Protection | Roofing - Moisture Protection | Waterproofing - Openings - Openings | Doors & Frames - Openings | Entrances & Storefronts - Openings | Glazing - Openings | Roof Windows & Skylights - Openings | Windows - Owner - Plumbing - Pollution & Waste Control Equipment - 'Process Gas & Liquid Handling, Purification, & Storage Equipment' - 'Process Heating, Cooling, & Drying Equipment' - Process Integration - Process Integration | Piping - Special Construction - Specialties - Specialties | Signage - Utilities - Water & Wastewater Equipment - Waterway & Marine Construction - Wood & Plastics - Wood & Plastics | Millwork - Wood & Plastics | Rough Carpentry UserProject: title: UserProjects x-stoplight: id: plmcgnhp47xzj type: object properties: id: type: string x-stoplight: id: 1c5qx7gynn1xb name: type: string x-stoplight: id: ksf91csdi2bww startDate: type: string x-stoplight: id: fvtfj8lc1z9zo endDate: type: string x-stoplight: id: h43bjx5szmsqe type: type: string x-stoplight: id: 8yoy6veksnyha classification: type: string x-stoplight: id: wpyl2maqv1tfw projectValue: type: object x-stoplight: id: 4azod9lx00sdp properties: value: type: number x-stoplight: id: 2u8hoxbsk0y3j currency: type: string x-stoplight: id: om037w3a0htka status: type: string x-stoplight: id: dcz1h6o6olnfv jobNumber: type: string x-stoplight: id: vo6fawen0jm7i addressLine1: type: string x-stoplight: id: i007upy8nhu2r addressLine2: type: string x-stoplight: id: co6e1yvqifdn2 city: type: string x-stoplight: id: tyvtrji3sdnbq stateOrProvince: type: string x-stoplight: id: ne8i2oguwq7w1 postalCode: type: string x-stoplight: id: us6vbwa65sgdt country: type: string x-stoplight: id: blhaa4hafsk7m latitude: type: string x-stoplight: id: hcnrvm61cvtir longitude: type: string x-stoplight: id: wavhek4j0ji86 timezone: type: string x-stoplight: id: r652g4e5s8iiz constructiontype: type: string x-stoplight: id: 72ssr45v7vf7r deliveryMethod: type: string x-stoplight: id: r9347swo3kufg contractType: type: string x-stoplight: id: n57ef17waubcc currentPhase: type: string x-stoplight: id: swkada61qtkp5 imageUrl: type: string x-stoplight: id: s13853c7sqfxj thumbnailImageUrl: type: string x-stoplight: id: pt070foltwzzm createdAt: type: string x-stoplight: id: eor56akwbojpr updatedAt: type: string x-stoplight: id: 7f2h4747y0g3d accountId: type: string x-stoplight: id: imb1079oceczz sheetCount: type: integer x-stoplight: id: k12b5jfgzcv3k platform: type: string x-stoplight: id: 34qz3ermzcqll accessLevels: x-stoplight: id: g6dygis0tn93s type: object properties: projectAdmin: type: boolean x-stoplight: id: 5mk3sjbuzvwbr projectMember: type: boolean x-stoplight: id: mpbt2fkkr3l82 UserProjectsPage: title: UserProjectsPage x-stoplight: id: 21k3qjv4voxsj type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array x-stoplight: id: gfyprxttv09sa items: $ref: '#/components/schemas/UserProject' userProjectFields: title: userProjectFields x-stoplight: id: fy1b5tna99hlx enum: - accessLevels - accountId - addressLine1 - addressLine2 - city - constructionType - country - createdAt - classification - deliveryMethod - endDate - imageUrl - jobNumber - latitude - longitude - name - platform - postalCode - projectValue - sheetCount - startDate - stateOrProvince - status - thumbnailImageUrl - timezone - type - updatedAt - contractType - currentPhase description: 'Possible values: accessLevels, accountId, addressLine1, addressLine2, city, constructionType, country, createdAt, classification, deliveryMethod, endDate, imageUrl, jobNumber, latitude, longitude, name, platform, postalCode, projectValue, sheetCount, startDate, stateOrProvince, status, thumbnailImageUrl, timezone, type, updatedAt, contractType and currentPhase.' userProjectFields_internal: title: userProjectFields_Internal x-stoplight: id: 05hzynqgt6ohg type: array items: $ref: '#/components/schemas/userProjectFields' userProjectAccessLevels_internal: title: userProjectAccessLevels_internal x-stoplight: id: 6k9hozeod0uw9 type: array items: $ref: '#/components/schemas/filterUserProjectsAccessLevels' userProjectSortBy: title: userProjectSortBy x-stoplight: id: daw62gto3pxxm description: 'Possible values: name, email, firstName, lastName, addressLine1, addressLine2, city, companyName, stateOrProvince, status, phone, postalCode, country and addedOn. Default value: name.' enum: - name asc - startDate asc - endDate asc - type asc - status asc - jobNumber asc - constructionType asc - deliveryMethod asc - contractType asc - currentPhase asc - createdAt asc - updatedAt asc - platform asc - name desc - startDate desc - endDate desc - type desc - status desc - jobNumber desc - constructionType desc - deliveryMethod desc - contractType desc - currentPhase desc - createdAt desc - updatedAt desc - platform desc userProjectSortBy_internal: title: userProjectSortBy_internal x-stoplight: id: lcab8shnq3bqn type: array items: $ref: '#/components/schemas/userProjectSortBy' Pagination: title: Pagination x-stoplight: id: q1bi13503pl18 type: object properties: limit: type: integer x-stoplight: id: 8izi1f176ek68 offset: type: integer x-stoplight: id: v1vdhhbk5vhtj totalResults: type: integer x-stoplight: id: o7y9s28pvovds nextUrl: type: string x-stoplight: id: egebyg74p2y51 previousUrl: type: string x-stoplight: id: rhoc949ms1w0p description: "\tContains pagination details for the records returned by the endpoint." filterUserProjectsAccessLevels: title: filterUserProjectsAccessLevels x-stoplight: id: puy9b77q6msat enum: - projectMember - projectAdmin description: ' Possible values: projectAdmin, projectMember.' CompaniesPage: title: AccountCompaniesPage x-stoplight: id: wuh03fw48u7sk type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array x-stoplight: id: ivk9ommljka7z items: $ref: '#/components/schemas/AccountCompany' AccountCompany: title: AccountCompany x-stoplight: id: dakt3mogkiqky type: object properties: id: type: string x-stoplight: id: ugixz7bx82y2w accountId: type: string x-stoplight: id: 726lpvp41ydqw name: type: string x-stoplight: id: e0gc4yiblj4sv trade: type: string x-stoplight: id: zmuamaitunhm3 addresses: type: array x-stoplight: id: 8kkwb15qm8yiu items: $ref: '#/components/schemas/AccountCompanyAddress' websiteUrl: type: string x-stoplight: id: fvtvf2kxtu9c2 description: type: string x-stoplight: id: qmcsqg0cptopm erpId: type: string x-stoplight: id: u7ixxmf1zmzmy taxId: type: string x-stoplight: id: jefyyyzhm87wo imageUrl: type: string x-stoplight: id: c7pk6958k6a3t status: type: string createdAt: type: string x-stoplight: id: pzy21nq11aest updatedAt: type: string x-stoplight: id: orpi3lguftr9n originalName: type: string x-stoplight: id: fgsaidhu4mqvh projectSize: type: integer x-stoplight: id: n3d4f06fgayfp userSize: type: integer x-stoplight: id: z0yopb69ae5er companyOrFilters: title: companyOrFilters x-stoplight: id: f204luot495u0 enum: - erpId - name - taxId - trade - updatedAt companyOrFilters_internal: title: companyOrFilters_internal x-stoplight: id: wopm3nw7uinr6 type: array items: $ref: '#/components/schemas/companyOrFilters' filterCompanySort: title: filterCompanySort x-stoplight: id: 5yrds3d69hbdb enum: - name asc - trade asc - erpId asc - taxId asc - status asc - createdAt asc - updatedAt asc - projectSize asc - userSize asc - name desc - trade desc - erpId desc - taxId desc - status desc - createdAt desc - updatedAt desc - projectSize desc - userSize desc filterCompanySort_internal: title: filterCompanySort_internal x-stoplight: id: 6rvwix917rwby type: array items: $ref: '#/components/schemas/filterCompanySort' filterCompanyFields_internal: title: filterCompanyFields_internal x-stoplight: id: n29a18k9ziwif type: array items: $ref: '#/components/schemas/filterCompanyFields' filterCompanyFields: title: filterCompanyFields x-stoplight: id: hp5r12lpjjgfa enum: - accountId - name - trade - addresses - websiteUrl - description - erpId - taxId - imageUrl - status - createdAt - updatedAt - projectSize - userSize - originalName AccountCompanyAddress: title: AccountCompanyAddress x-stoplight: id: w83g4phsegjmc type: object properties: type: type: string x-stoplight: id: vta9ily9vtev0 addressLine1: type: string x-stoplight: id: dibe53qdw3a5a addressLine2: type: string x-stoplight: id: 5cudpup7l7yoy city: type: string x-stoplight: id: awsdybgl6g2qh stateOrProvince: type: string x-stoplight: id: 98sc9ieedaak8 postalCode: type: string x-stoplight: id: 1mz7lqqjcnvqo country: type: string x-stoplight: id: t9pw98u1logv2 phone: type: string x-stoplight: id: m4r6utt1gzmnb ProductsPage: title: ProductsPage x-stoplight: id: xsphqarjuww5w type: object description: A list of products associated with the user properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array x-stoplight: id: 9a90u1uk439nr items: $ref: '#/components/schemas/Product' Product: title: Product x-stoplight: id: 31zy2tuwriypp type: object description: A list of ACC products the user is associated with. properties: key: x-stoplight: id: rer2vmrd4g1y7 type: string description: "A machine-readable identifier for the product (e.g., docs, build).\r\nEach product has a unique key used throughout the API for identification, filtering, and integration logic (e.g., in query parameters like filter[key]).\r\n\r\nPossible values: ACC - autoSpecs, build, cost, designCollaboration, docs, insight, modelCoordination, projectAdministration, and takeoff.\r\n\r\nBIM 360 - assets, costManagement, designCollaboration, documentManagement, field, fieldManagement, glue, insight, modelCoordination, plan, projectAdministration, projectHome, projectManagement, and quantification.\r\n\r\nNote that this endpoint returns only ACC products. Other endpoints, such as GET projects and GET projects/:projectId, may return both ACC and BIM 360 projects. In those responses, product keys may include BIM 360 values." icon: type: string x-stoplight: id: 4irlls1dstvd0 description: The URL of the icon associated with the product. name: type: string x-stoplight: id: yeot5qg0gkp7j description: The name of the product. projectIds: type: array x-stoplight: id: 73ybax84vwovq description: The list of projects IDs where the user is associated with the product. items: x-stoplight: id: 5it7z4q34r99z type: string filterProductKey: title: filterProductKey x-stoplight: id: ukcd26xywubto description: |- Filters the list of products by product key — a machine-readable identifier for an ACC product (such as docs, build, or cost). You can specify one or more keys to return only those products the user is associated with. Example: filter[key]=docs,build Possible values: accountAdministration, autoSpecs, build, buildingConnected, capitalPlanning, cloudWorksharing, cost, designCollaboration, docs, financials, insight, modelCoordination, projectAdministration, takeoff, and workshopxr. enum: - accountAdministration - autoSpecs - build - buildingConnected - capitalPlanning - cloudWorksharing - cost - designCollaboration - docs - financials - insight - modelCoordination - projectAdministration - takeoff - workshopxr filterProductKey_internal: title: filterProductKey_internal x-stoplight: id: ia0aei2c8mzor type: array items: $ref: '#/components/schemas/filterProductKey' filterProductField: title: filterProductField x-stoplight: id: 3bm7y2gmfkzn9 description: |- List of fields to return in the response. Defaults to all fields. Possible values: projectIds, name and icon. enum: - projectIds - name - icon filterProductField_internal: title: filterProductField_internal x-stoplight: id: fbqg01p4ahszs type: array items: $ref: '#/components/schemas/filterProductField' filterProductSort: title: filterProductSort x-stoplight: id: a3dgak2yoggvo description: |- The list of fields to sort by. Each property can be followed by a direction modifier of either asc (ascending) or desc (descending). The default is asc. Possible values: name. Default is the order in database. enum: - name asc - name desc filterProductSort_internal: title: filterProductSort_internal x-stoplight: id: an9jj1722wf9w type: array items: $ref: '#/components/schemas/filterProductSort' filterRoleStatus: title: filterRoleStatus x-stoplight: id: szbrna059dtnf description: |- Filters roles by their status. Accepts one or more of the following values: active – The role is currently in use. inactive – The role has been removed or is no longer in use. enum: - active - inactive filterRoleStatus_internal: title: filterRoleStatus_internal x-stoplight: id: unyj4odpflg05 type: array items: $ref: '#/components/schemas/filterRoleStatus' filterRoleField: title: filterRoleField x-stoplight: id: z2dxkedg44fnc description: |- A comma-separated list of response fields to include. Defaults to all fields if not specified. Use this parameter to reduce the response size by retrieving only the fields you need. Possible values: projectIds – Projects where the user holds this role name – Role name status – Role status (active or inactive) key – Internal key used to translate the role name createdAt – Timestamp when the role was created updatedAt – Timestamp when the role was last updated enum: - projectIds - name - status - key - createdAt - updatedAt filterRoleField_internal: title: filterRoleField_internal x-stoplight: id: yes8ynadosrxv type: array items: $ref: '#/components/schemas/filterRoleField' filterRoleSort: title: filterRoleSort x-stoplight: id: xuzincefhreh7 description: |- Sorts the results by one or more fields. Each field can be followed by a direction modifier: asc – Ascending order (default) desc – Descending order Possible values: name, createdAt, updatedAt. Default sort: name asc Example: sort=name,updatedAt desc enum: - name asc - createdAt asc - updatedAt asc - name desc - createdAt desc - updatedAt desc filterRoleSort_internal: title: filterRoleSort_internal x-stoplight: id: swdrk8sbdov1d type: array items: $ref: '#/components/schemas/filterRoleSort' RolesPage: title: RolesPage x-stoplight: id: 8kwl7yuzi534s type: object properties: pagination: $ref: '#/components/schemas/Pagination' results: type: array x-stoplight: id: 2dyfcimzwbq83 items: $ref: '#/components/schemas/Role' description: A list of requested roles associated with the user Role: title: Role x-stoplight: id: mwi2mj854b6ap type: object properties: id: type: string x-stoplight: id: 058zts2ymshko description: The unique ID of the role. status: type: string x-stoplight: id: 1nbbaygm0mwqq description: 'The role status. Possible values: active, inactive.' name: type: string x-stoplight: id: v1ouk468js1ew description: "The name of the role. Predefined roles are localized based on the request language.\r\nMax length: 255" key: type: string x-stoplight: id: gv2k753jxgux3 description: "The internal key used for translating predefined role names.\r\nMax length: 255" createdAt: type: string x-stoplight: id: awpgr8sjxn7gb description: The timestamp when the role was created. updatedAt: type: string x-stoplight: id: edcid2f8livhy description: The timestamp when the role was last updated. projectIds: type: array x-stoplight: id: zzo7mn0r5oqr9 description: The list of projects where the user is associated with this role. items: x-stoplight: id: 15ubmz0q77t5g type: string description: The requested page of roles associated with the user. securitySchemes: 2-legged: type: oauth2 flows: clientCredentials: tokenUrl: '' refreshUrl: '' scopes: {} 3-legged-implicit: type: oauth2 flows: implicit: authorizationUrl: '' refreshUrl: '' scopes: {} 3-legged: type: oauth2 flows: authorizationCode: authorizationUrl: '' tokenUrl: '' refreshUrl: '' scopes: {} security: - 2-legged: [] - 3-legged: [] tags: - name: Account Users - name: Business Units - name: Companies - name: Project Users - name: Projects - name: User Projects