projects/:project_id/users
GET
projects/:projectId/users
Retrieves information about all the users in a project. To get information about all the users in an account, see GET accounts/users.
Resource Information
Method and URI | GET https://developer.api.autodesk.com/bim360/admin/v1/projects/:projectId/users |
Authentication Context | user context optional |
Required OAuth Scopes | account:read |
Data Format | JSON |
Request
Headers
Authorization* string | Must be Bearer <token> , where <token> is obtained via either a two-legged or three-legged OAuth flow. |
Accept-Language string | The preferred languages for the user. This needs to support the relative quality factor (ex: en;q=0.8). Should be from the following supported list of BCP-47 codes: da [Danish], de [German], en [English], es [Spanish], fr [French], fr-CA [French, Canada], ja [Japanese], nl [Dutch], pt-BR [Portuguese, Brazil], sv [Swedish], zh-Hans [Chinese, Han]. Additional guidance on usage of the Accept-Language header is available here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language. |
Region string | The region the data is stored in. Possible values: US , EMEA . To find the region, call GET hubs. Specifying the region speeds up the request. |
User-Id string | In a two-legged authentication context, the app has access to all users specified by the administrator in the SaaS integrations UI. By providing this header, the API call will be limited to act on behalf of only the user specified. You can use either the user ID (id ), or the Autodesk ID (autodeskId ). |
* Required
Request
URI Parameters
projectId string: UUID | The project ID. 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. |
Request
Query String Parameters
filter[name] string | Filter project users by name. Can be a partial match based on the value of filterTextMatch provided.
Max length: 255 |
filter[email] string | Filter project users by email. Can be a partial match based on the value of filterTextMatch provided.
Max length: 255 |
filter[accessLevels] array: string | Filter project users by access level. Valid values are accountAdmin, projectAdmin and executive. For example filter[accessLevels]=accountAdmin,executive
Max length: 255 |
filter[companyId] string: UUID | Filter project users by company id. For example filter[companyId]=003e1a66-6775-4045-b3cc-cf0e614ff7b5
Max length: 255 |
filter[autodeskId] string | Filter project users by Autodesk id. For example filter[autodeskId]=LR3JVSFPDEAB
Max length: 255 |
filter[roleId] string: UUID | Filter project users by role id. For example filter[roleId]=883e1a66-6775-4045-b3cc-cf0e614ff7b5
Max length: 255 |
filter[memberGroupId] array: string | Filter project users who are members of the list of Autodesk groups. |
filter[serviceNames] array: string | Filter project users by the services they have access to. Valid values are costManagement, designCollaboration, documentManagement, fieldManagement, assets, insight, modelCoordination, accountAdministration, projectAdministration, projectManagement, projectHome, documents, sheets, field, glue and plan. For example filter[serviceNames]=glue,plan,sheets
Max length: 255 |
sort array: string | 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, email, firstName, lastName, addressLine1, addressLine2, city, stateOrProvince, postalCode and country. Default sort is name. |
fields array: string | List of fields to return in the response. Defaults to all fields. Valid list of fields are name, email, firstName, lastName, autodeskId, analyticsId, addressLine1, addressLine2, city, stateOrProvince, postalCode, country, imageUrl, phone, jobTitle, industry, aboutMe, companyId, accessLevels, roleIds and services. |
limit int | The number of records to return in a single request. Can be a number between 1 and 200. Defaults to 20. If a number greater than 200 is provided 200 will be returned. |
offset int | The number of records to skip before returning the result records. Increase this value in subsequent requests to continue getting results when the number of records exceeds the requested limit. |
Response
HTTP Status Code Summary
200 OK | The list of requested project users. |
400 Bad Request | The request could not be understood by the server due to malformed syntax. |
401 Unauthorized | Request has not been applied because it lacks valid authentication credentials for the target resource. |
403 Forbidden | The server understood the request but refuses to authorize it. |
404 Not Found | The resource cannot be found. |
406 | The server cannot produce a response matching the list of acceptable values defined in the request. |
409 Conflict | The request could not be completed due to a conflict with the current state of the resource. |
410 | Access to the target resource is no longer available. |
429 Too Many Requests | User has sent too many requests in a given amount of time. |
500 Internal Server Error | An unexpected error occurred on the server. |
503 | Server is not ready to handle the request. |
Response
Body Structure (200)
Expand all
pagination object | The information on the current page of a response. |
limit int | The number of results to include in the response. |
offset int | The record number to start with. |
totalResults int | The total number of records. |
nextUrl string | Url for the next page of records.
Max length: 2000 |
previousUrl string | Url for the previous page of records.
Max length: 2000 |
results array: object | The requested page of project users. |
id string: UUID | The internal identifier of the user |
email string | The email of the user.
Max length: 255 |
name string | The name of the user.
Max length: 255 |
firstName string | The user’s first name. This data will sync from the user’s Autodesk profile.
Max length: 255 |
lastName string | The user’s last name. This data will sync from the user’s Autodesk profile.
Max length: 255 |
autodeskId string | The identifier of the user’s Autodesk profile.
Max length: 255 |
anaylticsId string | Not relevant |
addressLine1 string | The address line 1 of the user. This data will sync from the user’s Autodesk profile.
Max length: 255 |
addressLine2 string | The address line 2 of the user. This data will sync from the user’s Autodesk profile.
Max length: 255 |
city string | The city of the user. This data will sync from the user’s Autodesk profile.
Max length: 255 |
stateOrProvince string | The state or province of the user. Accepted values here will change depending on which country is provided. This data will sync from the user’s Autodesk profile.
Max length: 255 |
postalCode string | The zip or postal code of the user. This data will sync from the user’s Autodesk profile.
Max length: 255 |
country string | The country of the user. This data will sync from the user’s Autodesk profile.
Max length: 255 |
imageUrl string | The url of the user’s avatar. This data will sync from the user’s Autodesk profile.
Max length: 255 |
phone object | The phone number of the user. This data will sync from the user’s Autodesk profile. |
number string | User’s phone number |
phoneType enum:string | User’s phone type. Can be home, mobile or office. Defaults to mobile.
Possible values: mobile , home , office |
extension string | User’s phone extension. |
jobTitle string | The job title of the user. This data will sync from the user’s Autodesk profile.
Max length: 255 |
industry string | The industry the user works in. This data will sync from the user’s Autodesk profile.
Max length: 255 |
aboutMe string | A short bio about the user. This data will sync from the user’s Autodesk profile.
Max length: 255 |
accessLevels object | Flags indicating the users access levels in the account. |
accountAdmin boolean | Indicates the user is an account admin in the account. |
projectAdmin boolean | Indicates the user is a project admin for the project. |
executive boolean | Indicates the user is an executive in the account. |
companyId string | The identifier of the company the user is representing in the project. |
roleIds array: string | The list of role ids the user belongs to in the project. |
services array: object | Flags indicating which services the user can access. |
serviceName enum:string | The name of the service.
Possible values: costManagement , designCollaboration , documentManagement , field , fieldManagement , assets , glue , insight , modelCoordination , plan , projectAdministration , projectManagement |
access enum:string | The user access to the service.
Possible values: none , member , administrator |
Example
The list of requested project users.
Request
curl -v 'https://developer.api.autodesk.com/bim360/admin/v1/projects/:projectId/users' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a'
Response
{
"pagination": {
"limit": 20,
"offset": 10,
"totalResults": 121,
"nextUrl": "http://resource?limit=20&offset=30",
"previousUrl": "http://resource?limit=20&offset=0"
},
"results": [
{
"id": "39712a51-bd64-446a-9c72-48c4e43d0a0d",
"email": "bob.smith@somewhere.com",
"name": "Bob Smith",
"firstName": "Bob",
"lastName": "Smith",
"autodeskId": "USER123A",
"anaylticsId": "SOMEID123",
"addressLine1": "123 Main Street",
"addressLine2": "Suite 2",
"city": "San Francisco",
"stateOrProvince": "California",
"postalCode": 94001,
"country": "United States",
"imageUrl": "https://s3.amazonaws.com:443/com.autodesk.storage.public.dev/oxygen/USER123A/profilepictures/x20.jpg",
"phone": {
"number": "123-345-1234",
"phoneType": "mobile",
"extension": "10"
},
"jobTitle": "Owner",
"industry": "Architecture & Construction Service Providers",
"aboutMe": "Bob has been in construction for 25 years",
"accessLevels": {
"accountAdmin": true,
"projectAdmin": true,
"executive": true
},
"companyId": "c32ffb13-83f8-43fb-bddf-3e5c0c2dda24",
"roleIds": [
"cda845af-05f0-4c46-9108-71b993946c35",
"b8e84a73-7506-4d3f-b221-93691df2a359"
],
"services": [
{
"serviceName": "documentManagement",
"access": "member"
},
{
"serviceName": "projectAdministration",
"access": "none"
}
]
}
]
}
Show More