ZAzaptec
Installation

Installations

Changed on

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

Request

  • Base URL
    https://api.zaptec.com
  • URL
    https://api.zaptec.com/api/installation
  • Auth
    OAuth 2
    Password
    Token URL: https://api.zaptec.com/oauth/token

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
totalCountinteger

Total number of rows across all pages.

messagestring nullable

Changes

  • ba5be4fed4a6Revision changes
    • breaking

      the // response's property format changed from double to decimal for status (media type: text/plain)

    • breaking

      the // response's property format changed from double to decimal for status (media type: application/json)

    • breaking

      the // response's property format changed from double to decimal for status (media type: text/json)

    • breaking

      the // response's property format changed from double to decimal for status (media type: text/plain)

    • breaking

      the // response's property format changed from double to decimal for status (media type: application/json)

    • breaking

      the // response's property format changed from double to decimal for status (media type: text/json)

    • info

      the endpoint scheme security legacy_auth was removed from the API

    • info

      added the optional property to the response with the status (media type: text/plain)

    • info

      added the optional property to the response with the status (media type: application/json)

    • info

      added the optional property to the response with the status (media type: text/json)