Table of contents
iTwins
Download API definition:
GET https://api.bentley.com/itwins/myprimaryaccount

Returns the primary Account for the calling user.

When a user creates a new iTwin, it will be created in the primary Account unless specified otherwise.

If a user is associated with an Organization, that user will be able to query for any Account iTwin owned by their Organization. If the Organization has more than one Account then the MyPrimaryAccount endpoint will return only the primary Account for that Organization. Other Accounts can be queried using the Get My iTwins endpoint with the subClass=Account parameter.

If a user is not associated with an Organization, then a single Account iTwin will be created for the user. The MyPrimaryAccount endpoint will return that Account.

Authentication

Requires Authorization header with valid Bearer token for scope itwin-platform.

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

Request headers

Name
Required?
Description
Authorization
Yes

OAuth access token with itwin-platform scope

Accept
Yes

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

Response 200 OK

OK

json
{
    "iTwin": {
        "id": "76c1102e-4f33-4dfa-ad93-bcd9ab717977",
        "class": "Account",
        "subClass": "Account",
        "type": null,
        "number": "Acme Corp.",
        "displayName": "Acme Corp."
    }
}

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
{
    "error": {
        "code": "HeaderNotFound",
        "message": "Header Authorization was not found in the request. Access denied."
    }
}

Response 429 Too many requests

This response indicates that the client sent more requests than allowed by this API for the current tier of the client.

json
{
    "error": {
        "code": "RateLimitExceeded",
        "message": "The client sent more requests than allowed by this API for the current tier of the client."
    }
}

Response headers

Name
Description
retry-after

Number of seconds to wait until client is allowed to make more requests.

iTwin-summary-response

Name
Type
Description

iTwin (summary)

Minimal representation of a iTwin that contains only id, class, subClass, type, number and displayName.

Name
Type
Description
id
String

The iTwin Id.

class

The Class of your iTwin.

subClass

The subClass your iTwin.

type
String, null

An open ended property to better define your iTwin's Type.

number
String

A unique number or code for the iTwin. This is the value that uniquely identifies the iTwin within your organization.

displayName
String

A display name for the iTwin.

status

Must be one of Active, Inactive or Trial. The default value is Active. By default, Inactive iTwins are not returned from the Get my iTwins API unless requested using the includeInactive parameter.

iTwin Status

One of 'Active', 'Inactive', 'Trial'

Name
Type
Description
Active
String
Inactive
String
Trial
String

iTwin Class

The Class of your iTwin.

Name
Type
Description
Account
String
Thing
String
Endeavor
String

iTwin SubClass

The subClass your iTwin.

Name
Type
Description
Account
String
Portfolio
String
Asset
String
Program
String
Project
String
WorkPackage
String

Error

Contains error information.

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, null

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.

Name
Type
Description
error

Error information.