File tree 3 files changed +126
-1
lines changed
3 files changed +126
-1
lines changed Original file line number Diff line number Diff line change 12
12
- ` /client_sessions `
13
13
- ` /connect_webviews `
14
14
- ` /connected_accounts `
15
- - ` /devices `
16
15
- ` /devices/simulate `
17
16
- ` /devices/unmanaged `
18
17
- ` /events `
Original file line number Diff line number Diff line change
1
+ # Devices
2
+
3
+ ## Endpoints
4
+
5
+ ### [ ` /devices/list ` ] ( ./list.md )
6
+
7
+ Returns a list of all [ devices] ( ../../core-concepts/devices/README.md ) .
Original file line number Diff line number Diff line change
1
+ # List Devices
2
+
3
+ ```
4
+ POST /devices/list ⇒ { devices: [device, …] }
5
+ ```
6
+
7
+ Returns a list of all [ devices] ( ../../core-concepts/devices/README.md ) .
8
+
9
+ ## Authentication Methods
10
+
11
+ - API key
12
+ - Client session token
13
+ - Personal access token
14
+ <br >Must also include the ` seam-workspace ` header in the request.
15
+
16
+ ## Request Parameters
17
+
18
+ ### ` connect_webview_id `
19
+
20
+ Type: ` string `
21
+ Required: No
22
+
23
+ ID of the Connect Webview by which to filter devices.
24
+
25
+ ***
26
+
27
+ ### ` connected_account_id `
28
+
29
+ Type: ` string `
30
+ Required: No
31
+
32
+ ID of the connected account by which to filter.
33
+
34
+ ***
35
+
36
+ ### ` connected_account_ids `
37
+
38
+ Type: ` array `
39
+ Required: No
40
+
41
+ Array of IDs of the connected accounts by which to filter devices.
42
+
43
+ ***
44
+
45
+ ### ` created_before `
46
+
47
+ Type: ` string `
48
+ Required: No
49
+
50
+ Date threshold for devices to return. If specified, returns only devices created before the specified date.
51
+
52
+ ***
53
+
54
+ ### ` custom_metadata_has `
55
+
56
+ Type: ` object `
57
+ Required: No
58
+
59
+ Set of key: value [ custom metadata] ( ../../core-concepts/devices/adding-custom-metadata-to-a-device.md ) pairs by which you want to filter devices.
60
+
61
+ ***
62
+
63
+ ### ` device_ids `
64
+
65
+ Type: ` array `
66
+ Required: No
67
+
68
+ Array of device IDs by which to filter devices.
69
+
70
+ ***
71
+
72
+ ### ` device_type `
73
+
74
+ Type: ` string `
75
+ Required: No
76
+
77
+ Device type by which to filter devices.
78
+
79
+ ***
80
+
81
+ ### ` device_types `
82
+
83
+ Type: ` array `
84
+ Required: No
85
+
86
+ Array of device types by which to filter devices.
87
+
88
+ ***
89
+
90
+ ### ` limit `
91
+
92
+ Type: ` number `
93
+ Required: No
94
+
95
+ Numerical limit on the number of devices to return.
96
+
97
+ ***
98
+
99
+ ### ` manufacturer `
100
+
101
+ Type: ` string `
102
+ Required: No
103
+
104
+ Manufacturer by which to filter devices.
105
+
106
+ ***
107
+
108
+ ### ` user_identifier_key `
109
+
110
+ Type: ` string `
111
+ Required: No
112
+
113
+ Your own internal user ID for the user by which to filter devices.
114
+
115
+ ***
116
+
117
+ ## Return Type
118
+
119
+ Array<[ device] ( ./ ) >
You can’t perform that action at this time.
0 commit comments