users
Retrieves a list of the BuildingConnected users in the requesting user’s company. The results are scoped to a given BuildingConnected company.
Note that invited external members of projects are not included in the response.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/construction/buildingconnected/v2/users |
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[officeId] string | The ID of an office with which users returned in the response must be associated. |
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 | Information about the returned BuildingConnected users. |
id string | The unique BuildingConnected ID of this user.
Max length: 24 |
autodeskId string | The user’s Autodesk ID. By default this value is null because an Autodesk ID is not a requirement to log in to BuildingConnected.
Users can associate their BuildingConnected user login with an Autodesk ID by going to account settings in BuildingConnected. Default: null |
emailVerified boolean | Indicates whether the user has verified the listed email address. Possible values:
|
employmentVerified boolean | Indicates whether the user’s employment at the company has been verified. Possible values:
|
createdAt datetime: ISO 8601 | The date and time that the user was created, in the following format: YYYY-MM-DDThh:mm:ss.sz (ISO 8601 format). |
firstName string | The user’s first name. |
lastName string | The user’s last name. |
email string | The user’s email address. |
jobTitle string | The user’s job title. |
phoneNumber string | The user’s phone number. |
companyId string | The unique BuildingConnected ID of the company to which this user belongs.
Max length: 24 |
isAccountClaimed boolean | Indicates whether the user has claimed their BuildingConnected account. Possible values:
|
bidBoardPermissions object | An object defining what permissions the user has in Bid Board. |
viewAll boolean | Indicates whether this user can view opportunities of which they aren’t explicitly a member. Possible values:
|
reports boolean | Indicates whether this user has access to the Reports tab on Bid Board. Possible values:
|
leaderboard boolean | Indicates whether this user has access to the Leaderboard tab on Bid Board. Possible values:
|
modifyPermissions boolean | Indicates whether the user can manipulate the Bid Board permissions of other users. Possible values:
|
offices array: object | An array of objects describing the offices to which this user belongs. |
id string | The unique ID of the office.
Max length: 24 |
isPrimary boolean | Indicates whether this office is the primary office of the user. A user can have only one priamry office. Possible values:
|
hasBbPro boolean | Indicates whether this office has an active Bid Board Pro subscription. Possible values:
|
hasBcPro boolean | Indicates whether this office has an active BuildingConnected Pro subscription. Possible values:
|
officeLead boolean | Indicates whether this user is a lead for this office. Users can set themselves as leads at any time.
|
name string | The name of this office. |
address string | The full street address of this office. |
Example
OK
Request
curl -v 'https://developer.api.autodesk.com/construction/buildingconnected/v2/users' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 100,
"cursorState": "eyJsaW1pdCI6MjUsIm9mZnNldCI6MjV9",
"nextUrl": ""
},
"results": [
{
"id": "5d8104b87e392d56e1e4b4ca",
"autodeskId": null,
"emailVerified": true,
"employmentVerified": true,
"createdAt": "2021-08-19T23:07:16.083Z",
"firstName": "First",
"lastName": "Last",
"email": "email@example.com",
"jobTitle": "Estimator",
"phoneNumber": "555-555-5555",
"companyId": "5d8104b87e392d56e1e4c7df",
"isAccountClaimed": "",
"bidBoardPermissions": {
"viewAll": true,
"reports": false,
"leaderboard": true,
"modifyPermissions": false
},
"offices": [
{
"id": "5b7104b87e392d56e1e4b3bf",
"isPrimary": true,
"hasBbPro": true,
"hasBcPro": false,
"officeLead": false,
"name": "San Francisco",
"address": "600 California St., 6th Floor, San Francisco, CA 94108"
}
]
}
]
}