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
{
"count": 6,
"next": null,
"previous": null,
"results": [
{
"id": 1584723961091234,
"upgrade_from": [],
"product_features": [
{
"id": 171,
"created_at": "2020-08-26T05:36:46Z",
"updated_at": "2020-08-26T05:36:46Z",
"name": "Feature 1",
"code": "f1",
"is_deleted": false,
"feature_type": "activation",
"max_consumption": 0,
"allow_overages": false,
"max_overages": 0,
"reset_consumption": false,
"consumption_period": null
},
{
"id": 172,
"created_at": "2020-08-26T05:37:14Z",
"updated_at": "2020-08-26T05:37:14Z",
"name": "Feature 2",
"code": "f2",
"is_deleted": false,
"feature_type": "consumption",
"max_consumption": 20,
"allow_overages": false,
"max_overages": 0,
"reset_consumption": false,
"consumption_period": null,
"metadata": {},
},
{
"id": 173,
"created_at": "2020-09-14T11:17:43Z",
"updated_at": "2020-09-14T11:17:43Z",
"name": "Feature 3",
"code": "f3",
"is_deleted": false,
"feature_type": "consumption",
"max_consumption": 2,
"allow_overages": false,
"max_overages": 0,
"reset_consumption": false,
"consumption_period": null,
"metadata": {},
},
{
"id": 189,
"created_at": "2020-11-13T07:40:53Z",
"updated_at": "2020-11-13T07:40:53Z",
"name": "Feature 5",
"code": "f5",
"is_deleted": false,
"feature_type": "activation",
"max_consumption": 0,
"allow_overages": false,
"max_overages": 0,
"reset_consumption": false,
"consumption_period": null,
"metadata": {},
}
],
"custom_fields": [
{
"id": 51,
"name": "Some key",
"data_type": null,
"default_value": "1234",
"description": null
},
{
"id": 60,
"name": "test_name",
"data_type": null,
"default_value": "123",
"description": null
},
{
"id": 61,
"name": "Key with space",
"data_type": null,
"default_value": "123",
"description": null
}
],
"installation_files": [
{
"id": 733282,
"created_at": "2020-10-13T09:15:22Z",
"updated_at": "2020-10-13T09:15:22Z",
"version": "0.1",
"full_link": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
"filename": "dummy.pdf",
"release_date": "2020-10-09",
"enabled": true,
"hash_md5": "",
"environment": "linux"
},
{
"id": 733283,
"created_at": "2020-10-13T09:15:52Z",
"updated_at": "2020-10-13T09:15:52Z",
"version": "0.2",
"full_link": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
"filename": "dummy.pdf",
"release_date": "2020-10-10",
"enabled": true,
"hash_md5": "sonotahash",
"environment": "linux"
}
],
"created_at": "2020-07-03T13:05:25Z",
"updated_at": "2020-07-07T12:35:05Z",
"product_name": "mch",
"short_code": "mch",
"active": true,
"valid_duration": "",
"allow_trial": false,
"trial_days": 0,
"max_activations": 1,
"hardware_id_required": false,
"is_upgrade": false,
"subscription_duration": "",
"enable_maintenance_period": false,
"maintenance_duration": "",
"is_floating": true,
"is_floating_cloud": false,
"floating_users": 12,
"floating_timeout": 120,
"default_license_type": "perpetual",
"is_user_locked": false,
"is_node_locked": true,
"max_consumptions": 1,
"authorization_method": "user",
"prevent_vm": false,
"allow_overages": false,
"max_overages": 0,
"reset_consumption": false,
"consumption_period": null,
"is_archived": false,
"metadata": {},
"company": 277
},
...
]
}
Updated 23 Apr 2024
![Doc contributor](https://s3.amazonaws.com/archbee-animals/dog.png)
![Doc contributor](https://s3.amazonaws.com/archbee-animals/lion.png)
Did this page help you?