Get Started
Documentation
Samples

Projects

Overview
Tutorials
Samples
Reference
Changelog
This API is deprecated. Please upgrade to the current version of this API as soon as possible.

Projects

Download API definition:
Get my projects
GET https://api.bentley.com/projects/[?projectNumber][&displayName][&$search][&$top][&$skip]

Retrieves a list of projects that can be accessed by the logged in user. The user is determined by the authentication token. See the Authorization section for information on how access rights are determined.

This API is being deprecated

This API is being superseded by the iTwins API and the Access Control API. Please consider transitioning your software to the iTwins API.

With any questions, please first consult the iTwins API FAQ. If your question isn't answered there, please use our Community Support Channels to contact our developers.

Authentication

Requires Authorization header with valid Bearer token for scope projects:read.

For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.

Authorization

User must be an Organization Administrator for the Organization that owns a given project or be a project team member.

An Organization Administrator must have at least one of the following roles assigned in User Management: Account Administrator, Co-Administrator, or CONNECT Services Administrator. For more information about User Management please visit our Bentley Communities Licensing, Cloud, and Web Services wiki page.

Response

By default, each project in the returned list of projects will have only the project id, display name and project number.

A full representation of each project can be returned by specifying the prefer header that includes a value of return=representation.

Request

Request parameters

Name
In
Required?
Description
projectNumber
query
No

Find all projects with the exact projectNumber specified. Cannot be used at the same time as the $search parameter.

displayName
query
No

Find all projects with the exact displayName specified. Cannot be used at the same time as the $search parameter.

$search
query
No

Find all projects that have the search string anywhere in the projectNumber or displayName. Cannot be used at the same time as the projectNumber or displayName parameters.

$top
query
No

The $top system query option requests the number of items in the queried collection to be included in the result.

$skip
query
No

The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.

Request headers

Name
Required?
Description
Prefer
No

Indicates a level of details in the response. Valid values are 'return=representation' or 'return=minimal'. The default is 'return=minimal'.

Authorization
Yes

OAuth access token with scope projects:read

Accept
No

Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.

Response

Response 200 OK

OK

json
Response 401 Unauthorized
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
json
Response 422 Unprocessable Entity
Invalid request to get projects
json
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
json
Response headers
Name
Description
retry-after
The number of requests exceeds the rate-limit for the client subscription.
Definitions
Project (summary)
Minimal representation of a project that contains only id, displayName and projectNumber.
TableSchema
Name
Type
Description
id
String
The Project Id.
displayName
String
The display name for the project.
projectNumber
String
The unique number or code for the project. This is the value that uniquely identifies the project within your organization.
Project
Full representation of a project.
TableSchema
Name
Type
Description
id
String
The Project Id.
displayName
String
The display name for the project.
projectNumber
String
The unique number or code for the project. This is the value that uniquely identifies the project within your organization.
registrationDateTime
String
The date that the project was created.
registeredBy
String
The Id of the user the created the project.
geographicLocation
String
The address or text description of the location of the project.
latitude
String
The latitude in degrees from -90 to 90.
longitude
String
The latitude in degrees from -180 to 180.
timeZone
String
The timezone that is being used on the project.
dataCenterLocation
String
The data center where the project data will be stored.
billingCountry
String
The ISO-3166 country code representing the billing country for this project.
status
ProjectStatus
One of active, inactive or trial.
allowExternalTeamMembers
Boolean
If false, then only users from the organization that owns the project can be given access to the project. If true, then users from external organizations can be given access to the project.
_links
project-links
Contains hyperlinks to project data stored in iTwin services.
Projects (prefer return=minimal)
A list of projects in the minimal representation format.
TableSchema
Name
Type
Description
projects
project-summary[]
A list of projects in the minimal representation format.
Projects (prefer return=representation)
A list of projects in the full representation format.
TableSchema
Name
Type
Description
projects
Project[]
A list of projects in the full representation format.
Link
Hyperlink container.
TableSchema
Name
Type
Description
href
String
Hyperlink container.
Project Links
Hyperlinks to related data for this project.
TableSchema
Name
Type
Description
storage
Link
Link to retrieve a list of storage data belonging to the project.
forms
Link
Link to retrieve a list of forms belonging to the project.
issues
Link
Link to retrieve a list of issues belonging to the project.
imodels
Link
Link to retrieve a list of iModels belonging to the project.
Project Status
One of 'active', 'inactive', 'trial'
TableSchema
Name
Type
Description
No data.
Error
Contains error information and an optional array of more specific errors.
TableSchema
Name
Type
Description
code
String
One of a server-defined set of error codes.
message
String
A human-readable representation of the error.
target
String
The target of the error.
details
ErrorDetails[]
Optional array of more specific errors.
Error Details
Contains error information.
TableSchema
Name
Type
Description
code
String
One of a server-defined set of error codes.
message
String
A human-readable representation of the error.
target
String
The target of the error.
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
TableSchema
Name
Type
Description
error
Error
Error information.