Management API
Product
List Products
5min
Show all products the requesting manager has access permissions to.
URL: /api/v1/products/
Method: GET
- order_by - Which attribute to order the list by.
- default ordering is ascending, can be made descending by prefixing the attribute name with -
- Example: order_by=created_at
- Example: order_by=-created_at
Default pagination is 20 results per page.
- limit - Number of results to return per page.
- Example: limit=20
- offset - The initial index from which to return the results.
- Example: offset=21
The results can be filtered by various attributes on product or related to the product.
Possible filters:
- is_archived
- short_code
- is_bundle
- metadata
Code: 200 OK
Content Examples:
JSON
1{
2 "count": 6,
3 "next": null,
4 "previous": null,
5 "results": [
6 {
7 "id": 1584723961091234,
8 "upgrade_from": [],
9 "product_features": [
10 {
11 "id": 171,
12 "created_at": "2020-08-26T05:36:46Z",
13 "updated_at": "2020-08-26T05:36:46Z",
14 "name": "Feature 1",
15 "code": "f1",
16 "is_deleted": false,
17 "feature_type": "activation",
18 "max_consumption": 0,
19 "allow_overages": false,
20 "max_overages": 0,
21 "reset_consumption": false,
22 "consumption_period": null
23 },
24 {
25 "id": 172,
26 "created_at": "2020-08-26T05:37:14Z",
27 "updated_at": "2020-08-26T05:37:14Z",
28 "name": "Feature 2",
29 "code": "f2",
30 "is_deleted": false,
31 "feature_type": "consumption",
32 "max_consumption": 20,
33 "allow_overages": false,
34 "max_overages": 0,
35 "reset_consumption": false,
36 "consumption_period": null,
37 "metadata": {},
38 },
39 {
40 "id": 173,
41 "created_at": "2020-09-14T11:17:43Z",
42 "updated_at": "2020-09-14T11:17:43Z",
43 "name": "Feature 3",
44 "code": "f3",
45 "is_deleted": false,
46 "feature_type": "consumption",
47 "max_consumption": 2,
48 "allow_overages": false,
49 "max_overages": 0,
50 "reset_consumption": false,
51 "consumption_period": null,
52 "metadata": {},
53 },
54 {
55 "id": 189,
56 "created_at": "2020-11-13T07:40:53Z",
57 "updated_at": "2020-11-13T07:40:53Z",
58 "name": "Feature 5",
59 "code": "f5",
60 "is_deleted": false,
61 "feature_type": "activation",
62 "max_consumption": 0,
63 "allow_overages": false,
64 "max_overages": 0,
65 "reset_consumption": false,
66 "consumption_period": null,
67 "metadata": {},
68 }
69 ],
70 "custom_fields": [
71 {
72 "id": 51,
73 "name": "Some key",
74 "data_type": null,
75 "default_value": "1234",
76 "description": null
77 },
78 {
79 "id": 60,
80 "name": "test_name",
81 "data_type": null,
82 "default_value": "123",
83 "description": null
84 },
85 {
86 "id": 61,
87 "name": "Key with space",
88 "data_type": null,
89 "default_value": "123",
90 "description": null
91 }
92 ],
93 "installation_files": [
94 {
95 "id": 733282,
96 "created_at": "2020-10-13T09:15:22Z",
97 "updated_at": "2020-10-13T09:15:22Z",
98 "version": "0.1",
99 "full_link": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
100 "filename": "dummy.pdf",
101 "release_date": "2020-10-09",
102 "enabled": true,
103 "hash_md5": "",
104 "environment": "linux"
105 },
106 {
107 "id": 733283,
108 "created_at": "2020-10-13T09:15:52Z",
109 "updated_at": "2020-10-13T09:15:52Z",
110 "version": "0.2",
111 "full_link": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
112 "filename": "dummy.pdf",
113 "release_date": "2020-10-10",
114 "enabled": true,
115 "hash_md5": "sonotahash",
116 "environment": "linux"
117 }
118 ],
119 "created_at": "2020-07-03T13:05:25Z",
120 "updated_at": "2020-07-07T12:35:05Z",
121 "product_name": "mch",
122 "short_code": "mch",
123 "active": true,
124 "valid_duration": "",
125 "allow_trial": false,
126 "trial_days": 0,
127 "max_activations": 1,
128 "hardware_id_required": false,
129 "is_upgrade": false,
130 "subscription_duration": "",
131 "enable_maintenance_period": false,
132 "maintenance_duration": "",
133 "is_floating": true,
134 "is_floating_cloud": false,
135 "floating_users": 12,
136 "floating_timeout": 120,
137 "default_license_type": "perpetual",
138 "is_user_locked": false,
139 "is_node_locked": true,
140 "max_consumptions": 1,
141 "authorization_method": "user",
142 "prevent_vm": false,
143 "allow_overages": false,
144 "max_overages": 0,
145 "reset_consumption": false,
146 "consumption_period": null,
147 "is_archived": false,
148 "metadata": {},
149 "company": 277
150 },
151 ...
152 ]
153}
Updated 23 Apr 2024
Did this page help you?