Download API definition:

GET https://sampleHostName/library/components[?$top][&$skip][&projectId][&$search][&catalogs]

Retrieves digital components from user's organization or project context.


By default, each entity in the returned list will have only the id and display name.

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


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

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


User must be an Organization Administrator for the Organization or have Read permission assigned at the organization level or have Read permission assigned at the project level, in case request is scoped to a project.

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.

Rate limits

All iTwin Platform API operations have a rate limit. For more documentation on that visit Rate limits and quotas page.