invites
Retrieves a list of the invites sent by the current user’s company to solicit proposals.
An invite represents a solicitation sent to a potential bidder to bid on a bid package. Invites may include individuals from multiple companies, but the invite is “owned” by one company. Invites create opportunities on the bidder’s Bid Board when the bid package is published. A company invited on multiple bid packages will recieve multiple invites.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/buildingconnected/v2/invites |
Authentication Context | user context required |
Required OAuth Scopes | data:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via a three-legged OAuth flow. |
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:
Default value: |
filter[projectId] string | The ID of a project with which the objects returned in the response must be associated. |
filter[bidPackageId] string | The ID of a bid package with which the objects returned in the response must be associated. |
filter[bidderCompanyId] string | The ID of a bidder company with which the objects returned in the response must be associated. |
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: |
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)
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:
|
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 invites created by the current user’s company. |
id string | The unique invite ID. If this company is invited to a different bid package, an additional entry will be generated.
Max length: 24 |
projectId string | The unique ID of the project with which the invite is associated.
Max length: 24 |
bidPackageId string | The unique ID of the bid package that the invite is for.
Max length: 24 |
bidderOfficeId string | The unique BuildingConnected office ID of the office that owns the invite.
Max length: 24 |
bidderCompany object | Information about a company. |
id string | The unique BuildingConnected ID of the company.
Max length: 24 |
name string | The name 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. |
state enum:string | The current state of the invite. The default state is NOT_INVITED . Possible values:
|
createdAt datetime: ISO 8601 | The date and time the bidder was included in the bid package, in ISO 8601 format. |
updatedAt datetime: ISO 8601 | The date and time of the latest update to the invite, in ISO 8601 format. |
invitedAt datetime: ISO 8601 | The date and time the invite was sent and the corresponding opportunity was created, in ISO 8601 format. |
invitees array: object | A list of users who have been invited. Note that invitees may not all belong to the same company. |
id string | The invitee’s ID.
Max length: 24 |
userId string | The unique BuildingConnected user ID of the invitee.
Max length: 24 |
firstName string | The invitee’s first name. |
lastName string | The invitee’s last name. |
companyId string | The ID of the invitee’s company.
Max length: 24 |
phoneNumber string | The invitee’s phone number. |
title string | The invitee’s professional title. |
email string | The invitee’s email address. |
inviterType enum:string | The type of inviter sending the bid invitation. Possible values: HOST , BIDDER , PUBLIC . |
state enum:string | The current state of the invitee. Possible values: NOT_INVITED (default), INVITED , VIEWED , REMOVED . |
Example
OK
Request
curl -v 'https://developer.api.autodesk.com/construction/buildingconnected/v2/invites?filter[updatedAt]=2020-05-01T06:00:00.000Z..' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 100,
"cursorState": "eyJsaW1pdCI6MjUsIm9mZnNldCI6MjV9",
"nextUrl": ""
},
"results": [
{
"id": "590dd527b359f408f191b5b6",
"projectId": "59d2bd7440b36a0da258f24d",
"bidPackageId": "590dd127b359f408f190b5a7",
"bidderOfficeId": "57d2bd7450b37a0c52585d2a",
"bidderCompany": {
"id": "51bea397f5846f95994b1da7",
"name": "Gr8 Builders",
"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"
}
]
},
"state": "UNDECIDED",
"createdAt": "2014-09-25T20:00:00.000Z",
"updatedAt": "2014-09-25T21:00:00.000Z",
"invitedAt": "2014-09-25T20:30:00.000Z",
"invitees": [
{
"id": "5cfe43c079b25e7dcafc104d",
"userId": "5bff41c079b25e7ccebc202e",
"firstName": "First",
"lastName": "Last",
"companyId": "51bea397f5846f95994b1da7",
"phoneNumber": "555-555-5555",
"title": "Estimator",
"email": "someone@gmail.com",
"inviterType": "HOST",
"state": "INVITED"
}
]
}
]
}