API Reference
Contact us

Installations

get
https://api.zaptec.com/api/installation

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
enum

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

int32
enum

Return only installations of the provided type.

0 = Pro

1 = Smart

Allowed:
string

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

string

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

boolean

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

string

Name of the property used to sort the result.

boolean

Set to true to sort items in descending order.

int32

Number of items to return per page.

int32

The page index to return, first page is 0.

boolean

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

Exclude
array of uuids

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

Exclude
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

403

Forbidden

Updated 10 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 10 months ago