Projects

Projects

Download API definition:

GET https://sampleHostName/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.

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 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 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.