Get sites

This endpoint returns the list of sites; site ID and other information related to the site the user belongs to. If a user belongs to multiple sites, multiple sites will be shown in the response.

You need the site ID for various calls, please store this along with the user, to save on API calls.

0
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Endpoint: "/v1.1/sites"
Method: GET

            
Response Content Type (application/json):
{
  
items;
type: array

items returned as result

"items"
: [ {
id;
type: string, format: uuid;

The id of the site

"id"
: "string",
customer_reference;
type: string

The name of the site

"customer_reference"
: "string",
subscribed_user_amount;
type: integer, format: int32;

Shows the number of subscribed users for that site

"subscribed_user_amount"
: "integer",
subscription_valid;
type: boolean

Subscription state of the site

"subscription_valid"
: boolean,
country_code;
type: string

The country of the site

"country_code"
: "string",
site_uid;
type: string

The uid of the site

"site_uid"
: "string",
time_zone;
type: string

The time zone the site is in

"time_zone"
: "string",
owner;

The owner of the site

"owner"
: [ {
email;
type: string

email of the user

"email"
: "string",
image_url;
type: string

The url of the profile picture

"image_url"
: "string",
tag_number;
type: string

Tag number

"tag_number"
: "string",
is_managed_by_current_site;
type: boolean

Wether the user is managed by the selected site

"is_managed_by_current_site"
: boolean,
has_profile;
type: boolean

Wether the user has its own profile

"has_profile"
: boolean,
id;
type: string, format: uuid;

id of the user

"id"
: "string",
first_name;
type: string

First name of the user

"first_name"
: "string",
last_name;
type: string

Last name of the user

"last_name"
: "string" } ],
installation_state;
type: string

The installation state of the site

"installation_state"
: "string",
mkey_compatible;
type: boolean

Indicates whether site is mobile key compatible

"mkey_compatible"
: boolean } ],
next_page_link;
type: string

next page uri link

"next_page_link"
: "string",
count;
type: integer, format: int64;

number of items returned

"count"
: "integer" }