Request

Response

    Projects
    GET

    projects

    Retrieves a list of the BuildingConnected projects a user has access to. By default, only projects owned by the requesting user’s company are provided. This endpoint will additionally return projects owned by other companies when the includeExternal parameter is provided.

    A BuildingConnected project represents a request for proposals, typically representing a single phase of bidding. It can be linked to a Forma project, but it’s technically separate, and may be related to the Forma project on a many-to-one basis. For example: a project may go through three phases of bidding before proceeding to site construction; this process could potentially be represented by three BuildingConnected projects and one Forma project.

    A project is a top-level container for all scopes of work in a phase of bidding. Each individual scope of work is presented as a bid package. Each bid package has bidders (represented by invites to bid), and each bidder creates bids in response to an invite.

    Resource Information

    Method and URI
    GET
    https://developer.api.autodesk.com/construction/buildingconnected/v3/projects
    Authentication Context
    User context required
    Required OAuth Scopes
    data:read
    Data Format
    JSON

    Request

    Headers

    Authorization*
    string
    Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow.
    * Required

    Request

    Query String Parameters

    cursorState
    string
    An opaque cursor token that identifies where the next page of paginated results should start. It’s returned in each paginated response so that it can be provided in the next request to continue paginated results. If a paginated response contains no cursorState value, there are no further pages to return.

    Omit this parameter to initiate a paginated request or to restart pagination.

    limit
    int
    The maximum number of records that the endpoint may return per page.

    Note that a returned page may contain fewer records than the limit under either of these conditions:

    • There are fewer records found than the limit value.
    • The last page of a set is returned.

    Default value: 100

    filter[updatedAt]
    string
    The required range of dates and times during which the last update must have been made to the objects returned in the response, in ISO 8601 format.

    A single date and time takes this format: YYYY-MM-DDThh:mm:ss.SSSZ, A date and time range takes this format: YYYY-MM-DDThh:mm:ss.SSSZ..YYYY-MM-DDThh:mm:ss.SSSZ. Range queries can be closed or open in either direction: YYYY-MM-DDThh:mm:ss.SSSZ.. or ..YYYY-MM-DDThh:mm:ss.SSSZ.

    filter[owningOfficeId]
    array: string
    A comma separated list of office IDs that own the relevant objects. The owningOfficeId must belong to the requesting user’s company.
    filter[userId]
    string
    The unique BuildingConnected user ID for which to query projects. Only projects this user has access to will be provided. Results will only include projects for which the requesting user also has access. The userId must belong to the requesting user’s company.
    filter[currentAccLinkedProjectId]
    string
    The ID of a Forma project with which the objects returned in the response are associated with BuildingConnected projects that are linked to this Forma Project.
    filter[isTemplate]
    boolean
    Filters projects by whether they are templates.
    filter[createdBy]
    string
    Filters projects by the BuildingConnected user ID of the user that created them.
    searchText
    string
    Search for projects whose name or number matches this text. It is case-insensitive and only matches from the start of a word.
    includeClosed
    boolean
    Whether to include closed projects in the response. Possible values:
    • true: Closed projects are included.
    • false: (Default) Closed projects are not included.
    includeExternal
    boolean
    Whether to include projects from external companies in the response. Possible values:
    • true: External projects are included.
    • false: (Default) External projects are not included.

    Note that this filter can be used only with filter[userId] or filter[currentAccLinkedProjectId].

    Response

    HTTP Status Code Summary

    200
    OK
    OK
    400
    Bad Request
    The parameters of the requested operation are invalid.
    401
    Unauthorized
    The provided bearer token is not valid.
    403
    Forbidden
    The user or service represented by the bearer token does not have permission to perform this operation.
    404
    Not Found
    The requested resource could not be found.
    429
    Too Many Requests
    Rate limit exceeded; wait some time before retrying. The ‘Retry-After’ header might provide the amount of the time to wait.
    500
    Internal Server Error
    An unknown error occurred on the server.

    Response

    Body Structure (200)

    Expand all
    pagination
    object
    The pagination details of a response.
    limit
    int
    The maximum number of records to return per page.

    Note that a returned page may contain fewer records than the limit under either of these conditions:

    • There are fewer records found than the limit value.
    • The last or only page is returned.
    cursorState
    string
    An opaque cursor token that identifies where the next page of paginated results should start. It’s returned in each paginated response so that it can be provided in the next request to continue paginated results. If a paginated response contains no cursorState value, there are no further pages to return.

    Omit this parameter to initiate a paginated request or to restart pagination.

    nextUrl
    string
    The URL path that returns the next page of data.
    results
    array: object
    The details of the returned BuildingConnected Pro projects of the current user’s company.
    id
    string
    The BuildingConnected project’s unique ID.

    Note that this is not equivalent to a Forma project ID.

    Max length: 24

    name
    string
    The user-defined name of the project. The name need not be unique.
    number
    string
    The user-defined prefix for the project name. This value is prepended to name on invites sent to bidders. The value need not be unique.
    company
    object
    Information about a company.
    id
    string
    The unique BuildingConnected ID of the company.

    Max length: 24

    name
    string
    The name of the company.
    avatarImageUrl
    string
    The cached imgix url for the avatar image of the company.
    businessType
    array: string
    The type of business carried out by the company.
    website
    string
    The company’s official website.
    laborType
    array: string
    Specifies the labor payment structure within the company, such as Non-Union or Prevailing Wages.
    enterpriseType
    array: string
    This has been deprecated and replaced with certificates.
    companyTags
    array: string
    A list of tags assigned by your organization to categorize this company. Note that this information is private to your organization and not visible to others.
    certificates
    array: object
    A collection of certificates held by the company. This field replaces the deprecated enterpriseType field.
    id
    string
    The unique identifier for each certificate. Companies can hold multiple certificates, each with its own ID. The field is null for pending certificate suggestions.

    Max length: 24

    type
    object
    Details about the specific type of certificate.
    id
    string
    The unique ID of the certificate type.

    Max length: 24

    name
    string
    The name of the certificate type.
    agency
    object
    Details about the agency that issued the certificate.
    id
    string
    The unique identifier for the certifying agency.

    Max length: 24

    name
    string
    The name of the certifying agency.
    website
    string
    The official website URL of the certifying agency.
    number
    string
    The certificate’s unique identification number.
    expiresAt
    datetime: ISO 8601
    The date the certificate expires, in ISO 8601 format.
    fileName
    string
    The name of the digital copy of the certificate.
    client
    string
    A user-defined identifying name for the client for whom the project is being bid.

    Note that this value is private to your company and is not displayed to bidders.

    description
    string
    A detailed description of the project with HTML markup.
    notes
    string
    Miscellaneous user-added notes with HTML markup.

    Note that this value is private to your company and is not displayed to bidders.

    value
    number
    The monetary value of the project.

    Note that BuildingConnected projects do not have multi-currency support; all monetary values for a project, including bids, are assumed to be in the same currency.

    Note that this value is private to your company and is not displayed to bidders.

    projectSize
    number
    The magnitude of the project, in the units that you specify in projectSizeUnits (SQUARE_FEET or SQUARE_METERS).
    projectSizeUnits
    enum:string
    The unit type of projectSize that was specified when creating or updating the project. Possible values:
    • SQUARE_FEET: Project size in square feet.
    • SQUARE_METERS: Project size in square meters.
    awarded
    enum:string
    Indicates whether the project was won or lost. Defaults to UNKNOWN until changed. Possible values:
    • WON
    • LOST
    • UNKNOWN (Default)

    Note that this value is private to your company and not displayed to bidders.

    isBiddingSealed
    boolean
    Indicates whether the project’s bids are sealed. Sealed bids cannot be accessed until the due date is past, and new bids cannot be submitted if the due date is past. Possible values:
    • true: The project’s bids are sealed.
    • false: The project’s bids are not sealed.
    bidAdminUserId
    string
    The unique BuildingConnected ID of the user set as the “Bid Administrator” when project’s bids are sealed. Only the bid administrators can unseal bids after the bid’s due date.

    Max length: 24

    state
    enum:string
    Indicates whether a project is unpublished, published, or closed. Possible values:
    • DRAFT: (Default) The project is unpublished.
    • PUBLISHED: One or more of the project’s bid packages has been published.
    • CLOSED: The project has been manually inactivated. CLOSED projects are severely limited in functionality.
    isNdaRequired
    boolean
    Indicates whether a non-disclosure agreement (NDA) is required on the project. Possible values:
    • true: The project requires an NDA.
    • false: The project does not require an NDA.
    nda
    object
    Information about the non-disclosure agreement (NDA) that team members and bidder users must sign to access the project.
    id
    string
    The ID of the non-disclosure agreement (NDA) that team members and bidder users must sign to access the project.

    Max length: 24

    name
    string
    The name of the non-disclosure agreement (NDA) required to be signed to access the project.
    createdAt
    datetime: ISO 8601
    The date and time that the project nda was created, in ISO 8601 format.
    createdBy
    string
    The BuildingConnected user ID of the user who created the non-disclosure agreement (NDA).

    Max length: 24

    isProjectNameShownBeforeSigningNda
    boolean
    Indicates whether users who have not signed the non-disclosure agreement (NDA) can see the project name. Possible values:
    • true: The project name is always visible to users.
    • false: The project name is redacted for users who have not signed the NDA.
    isPublic
    boolean
    Indicates whether the project is listed in your company’s public plan room. Possible values:
    • true: The project is public.
    • false: The project is not public.
    createdAt
    datetime: ISO 8601
    The date and time that the project was created, in ISO 8601 format.
    updatedAt
    datetime: ISO 8601
    The date and time of the last change made to the project, in ISO 8601 format.
    publishedAt
    datetime: ISO 8601
    The date and time that a bid package on the project was first published, in ISO 8601 format.
    bidsDueAt
    datetime: ISO 8601
    The date and time deadline by which bidders must submit bids on this project, in ISO 8601 format.

    This field provides the default due date for the project’s bid packages, after which you can set an independent due date for each bid package.

    endsAt
    datetime: ISO 8601
    The expected end date and time of the project in ISO 8601 format.
    rfisDueAt
    datetime: ISO 8601
    The date and time deadline by which bidders must submit RFIs for this project, in ISO 8601 format.
    startsAt
    datetime: ISO 8601
    The expected start date and time of the project in ISO 8601 format.
    jobWalkAt
    datetime: ISO 8601
    The date and time that bidders invited to this project may come to the site and do a job walk, in ISO 8601 format.
    dueAt
    datetime: ISO 8601
    The date and time deadline by which your bid must be submitted to the client, in ISO 8601 format.

    Note that this value is private to your company and is not displayed to bidders.

    closedAt
    datetime: ISO 8601
    The date and time that the project was closed, in ISO 8601 format.
    location
    object
    The structured address details for a location.
    country
    string
    The country code of the location.
    state
    string
    The state, territory, or province code of the location.
    streetName
    string
    The street name of the location. This can be combined with streetNumber to get the street address.
    streetNumber
    string
    The numeric value of the street address. This can be combined with streetName to get the street address.
    suite
    string
    The suite number or second address line of the location.
    city
    string
    The city of the location.
    zip
    string
    The ZIP or Postal code of the location.
    complete
    string
    The complete human-readable address of the location.
    coords
    object
    The latitude and longitude coordinates of the location.
    lat
    number
    The geographic latitude of the location.
    lng
    number
    The geographic longitude of the location.
    precisionLevel
    int
    The precision with which location identifies an actual place, on a scale of 0 to 10.
    • 0 is the least precise indication, such as mapping to a country.
    • 10 is the most precise indication, such as mapping to a street number or intersection.

    This value is initially null, and is populated only after a location change.

    isTemplate
    boolean
    Indicates whether the project is a template. Possible values:
    • true: This project is a template.
    • false: This project is not a template.
    isBidFormTemplate
    boolean
    Indicates whether the project is a bid form template. Possible values:
    • true: This project is a bid form template.
    • false: This project is not a bid form template.
    accountManager
    string
    The name of your company’s primary business contact responsible for communicating with the client owner of the project.

    Note that this value is private to your company and is not displayed to bidders.

    feePercentage
    number
    A numeric value expressing the fee that your company will charge for the project. This value is a rational number that represents a percentage. For example, 15.55% is represented as 15.55.

    Note that this value is private to your company and is not displayed to bidders.

    marketSector
    string
    A description of the market sector that the project is in.
    createdBy
    string
    The BuildingConnected user ID of the user who created the project.

    Max length: 24

    defaultCurrency
    string
    The currency denomination used for the project. Possible values:
    • AUD: Australian dollar
    • CAD: Canadian dollar
    • EUR: Euro
    • GBP: British pound
    • USD: U.S. dollar
    • NZD: New Zealand dollar

    Note that future values will follow the ISO 4217 format for currencies.

    owningOfficeId
    string
    The office ID (not the company ID) of the project owner.

    Max length: 24

    architect
    string
    The name of the architect on the project.
    isForBudgeting
    boolean
    Indicates whether the project is for budgeting rather than for bidding. Possible values:
    • true: The project is for creating budgeting requests.
    • false: The project is for creating bidding invites.
    isCompetitive
    boolean
    Indicates whether this is a competitive or “hard bid” project rather than a negotiated project. Possible values:
    • true: The project is competitive.
    • false: The project is negotiated.

    This information is private to your company and is not shared with bidders.

    currentAccLinkedProjectId
    string
    The project ID of the currently linked Forma project. Multiple BuildingConnected projects can be linked to one Forma project.

    Note that when this value is null, currentAccDocsFolderId is also null.

    currentAccLinkedHubId
    string
    The hub ID of the currently linked Forma project. Multiple BuildingConnected projects can be linked to one Forma project.
    originalProjectId
    string
    The unique ID of the original template or project if this project was created by importing from a template or existing project.

    Max length: 24

    currentAccDocsFolderId
    string
    The unique ID of an Autodesk Forma Data Management folder in the linked Forma project. Files in this folder are shared with all bidders.

    Note that this value is null under any of the following conditions:

    • The value of currentAccLinkedProjectId is null.
    • This project isn’t linked to a Forma project.
    • A folder hasn’t been created yet.
    • No folder is currently associated (e.g., it was not selected or was explicitly removed).
    accProjectLinkedAt
    datetime: ISO 8601
    The date and time that this BuildingConnected project was linked to the currently linked Forma project, in ISO 8601 format.
    relevantCertificates
    array: object
    An array of certificates relevant to the project. Bidders with any certificate meeting these criteria will be identified as relevantly certified bidders in the project interface.
    agency
    object
    A certifying agency that’s relevant to this project.
    id
    string
    The unique ID of the certifying agency.

    Max length: 24

    name
    string
    The name of the certifying agency.
    website
    string
    The website URL of the certifying agency.
    certificateType
    object
    A type of certificate (issued by the specified agency) that’s relevant to this project.
    id
    string
    The unique ID of the certificate type.

    Max length: 24

    name
    string
    The name of the certificate type.
    opportunityProjectPair
    object
    Information about the opportunity paired to this project. This pairing enables the project to use various types of content from the opportunity as specified when the project was created.
    id
    string
    The unique ID of the opportunity project pair.
    opportunityId
    string
    The unique ID of the opportunity paired to this project.
    bidFormId
    string
    The unique ID of the bid form associated with this project.
    aiProposalExtraction
    boolean
    Indicates whether the project is opted into AI proposal extraction. Possible values:
    • true: AI will be used to extract data from proposals.
    • false: AI will not be used to extract data from proposals.

    Example

    OK

    Request

    curl -v 'https://developer.api.autodesk.com/construction/buildingconnected/v3/projects?filter[updatedAt]=2020-05-01T06:00:00.000Z..&filter[userId]=5d8104b87e392d56e1e4b4ca&filter[currentAccLinkedProjectId]=00f1b796-293a-4c1e-9474-f09711011426' \
      -H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
    

    Response

    {
      "pagination": {
        "limit": 100,
        "cursorState": "eyJsaW1pdCI6MjUsIm9mZnNldCI6MjV9",
        "nextUrl": "https://developer.api.autodesk.com/construction/buildingconnected/v3/project-team-members?cursorState=eyJsaW1pdCI6MjUsIm9mZnNldCI6MjV9"
      },
      "results": [
        {
          "id": "59d2bd7440b36a0da258f24d",
          "name": "Office Renovation",
          "number": "12345",
          "company": {
            "id": "51bea397f5846f95994b1da7",
            "name": "Gr8 Builders",
            "avatarImageUrl": "https://www.example.com/",
            "businessType": [
              "Subcontractor"
            ],
            "website": "https://www.example.com",
            "laborType": [
              "Union"
            ],
            "enterpriseType": [
              "Disadvantaged Business Enterprise (DBE)"
            ],
            "companyTags": [
              "example_tag"
            ],
            "certificates": [
              {
                "id": "627074db25c97830ad3ea8c8",
                "type": {
                  "id": "59d2bd7440b36a0da258f24d",
                  "name": "Disadvantaged Business Enterprise (DBE)"
                },
                "agency": {
                  "id": "611d794f7f063800a7274d46",
                  "name": "United States Department of Transportation",
                  "website": "https://www.transportation.gov/civil-rights/disadvantaged-business-enterprise"
                },
                "number": "12345",
                "expiresAt": "2014-10-03T19:00:00.000Z",
                "fileName": "certificate.pdf"
              }
            ]
          },
          "client": "Wells Fargo",
          "description": "This is an <em>important</em> project.",
          "notes": "<div>This project's <b>important</b> notes.</div>",
          "value": 1000000,
          "projectSize": 2000,
          "projectSizeUnits": "SQUARE_FEET",
          "awarded": "WON",
          "isBiddingSealed": false,
          "bidAdminUserId": "5d8104b87e392d56e1e4b4ca",
          "state": "PUBLISHED",
          "isNdaRequired": false,
          "nda": {
            "id": null,
            "name": "NDA Agreement",
            "createdAt": "2014-09-22T16:27:37.437Z",
            "createdBy": "5a1dc3cf5b54e06ca307d7af"
          },
          "isProjectNameShownBeforeSigningNda": false,
          "isPublic": false,
          "createdAt": "2014-09-22T16:27:37.437Z",
          "updatedAt": "2014-09-23T16:28:37.437Z",
          "publishedAt": "2014-09-22T21:34:44.511Z",
          "bidsDueAt": "2014-09-22T16:27:37.437Z",
          "endsAt": "2015-03-31T07:00:00.000Z",
          "rfisDueAt": "2014-09-25T19:00:00.000Z",
          "startsAt": "2014-11-03T08:00:00.000Z",
          "jobWalkAt": "2015-03-31T07:00:00.000Z",
          "dueAt": "2014-09-03T08:00:00.000Z",
          "closedAt": "2014-09-03T08:00:00.000Z",
          "location": {
            "country": "US",
            "state": "CA",
            "streetName": "California St.",
            "streetNumber": "600",
            "suite": "6th Floor",
            "city": "San Francisco",
            "zip": "94108",
            "complete": "600 California St., 6th Floor, San Francisco, CA 94108",
            "coords": {
              "lat": -122.4069826,
              "lng": 37.7929546
            },
            "precisionLevel": 10
          },
          "isTemplate": false,
          "isBidFormTemplate": false,
          "accountManager": "Name of account manager",
          "feePercentage": 15.55,
          "marketSector": "Sports Stadium Construction",
          "createdBy": "5a1dc3cf5b54e06ca307d7af",
          "defaultCurrency": "USD",
          "owningOfficeId": "5fcdcd0b3db0876c6692d5bb",
          "architect": "Browning Day Mullins Dierdorf Architects",
          "isForBudgeting": false,
          "isCompetitive": true,
          "currentAccLinkedProjectId": "00f1b796-293a-4c1e-9474-f09711011426",
          "currentAccLinkedHubId": "28b0d8b3-4730-4f4f-8bad-4a2a5d75ed26",
          "originalProjectId": "5dedcd0b3db0676d6722d6ac",
          "currentAccDocsFolderId": "urn:adsk.wipprod:fs.folder:co.BJU3PTc4Sd2CmXM492XUiA",
          "accProjectLinkedAt": "2014-10-03T19:00:00.000Z",
          "relevantCertificates": [
            {
              "agency": {
                "id": "611d794f7f063800a7274d46",
                "name": "United States Department of Transportation",
                "website": "https://www.transportation.gov/civil-rights/disadvantaged-business-enterprise"
              },
              "certificateType": {
                "id": "59d2bd7440b36a0da258f24d",
                "name": "Disadvantaged Business Enterprise (DBE)"
              }
            }
          ],
          "opportunityProjectPair": {
            "id": "5c3f0a5c9ca3dda548312ea5",
            "opportunityId": "5d3f0a5c9ca3dda548312ea7"
          },
          "bidFormId": "60f7c8e2b4d1c9001c8e4b2a",
          "aiProposalExtraction": false
        }
      ]
    }
    
    Show More