v1

latestOpenAPI 3.0.42026-07-241876123.9 KB
Installation

Installations

Retrieves all installations accessible by the current user, matching the provided filters.

By default, returns the first 50 items. Use <b>pageIndex</b> for pagination or adjust <b>pageSize</b> (max: 100).

get/api/installation

Query parameters

Roles0 | 1 | 2 | 4 | 8 | 15 | 16 | 32 | 64 | 128 | 256

0 = None

1 = User

2 = Owner

4 = Maintainer

8 = Administrator

15 = Any

16 = Onboarding

32 = DeviceAdministrator

64 = PartnerAdministrator

128 = Technical

256 = InternalData

Return only installations where current user has any of the provided user roles. Note that this is a bit-flag and multiple roles can be provided.

0 = None

1 = User

2 = Owner

4 = Maintainer

8 = Administrator

15 = Any

16 = Onboarding

32 = DeviceAdministrator

64 = PartnerAdministrator

128 = Technical

256 = InternalData

InstallationType0 | 1

0 = Pro

1 = Smart

Return only installations of the provided type.

0 = Pro

1 = Smart

ExcludeIfVisibleForUserGroupLookupKeystring

Excludes installations that is visible for the user group identified by lookup key.

NameFilterstring

A filter used to filter items. The filter may be applied to multiple properties depending on the object type.

ReturnIdNameOnlyboolean

If true objects are only returned with their basic properties like Id and name.

SortPropertystring

Name of the property used to sort the result.

SortDescendingboolean

Set to true to sort items in descending order.

PageSizeinteger

Number of items to return per page.

PageIndexinteger

The page index to return, first page is 0.

IncludeDisabledboolean

If true, and your user has access, include disabled objects.

Excludestring[]

Get or set a list of item Id's that will be excluded from the result.

PageInfoOnlyboolean

Returns only information about pages and no data info.

Response

OK

pagesinteger
messagestring nullable