Get All the Features for a Specific Product
Overview
Returns the list of features and their key values for a specified product
Endpoint
GET
https://api.salable.app/products/{Product UUID}/features
Where {product UUID} is the UUID for the specific product. This can be copied from the products page of the dashboard.
Headers
Header Name | Description | Required | Value |
---|---|---|---|
x-api-key | Your API key, from the Salable Dashboard | string |
Sample Request
https://api.salable.app/products/e6d24c05-6ceb-46af-8168-2eea7f35e252/features
x-api-key: "Your API Key"
Response
The response is an array of objects.
Element | Description | Type | Notes | |
---|---|---|---|---|
uuid | The UUID of the Product | string | ||
name | The name given to the feature in the Salable Dashboard | string | ||
description | The description of the feature, for use in tooltips | string | ||
displayName | The display name for the feature definined in the Salable Dashboard | string | ||
variableName | The variable name assigned in the Salable Dashboard | string | ||
status | Indicates if the feature is currently active | string | ACTIVE or DEPRECATED | |
visibility | Identifies if the feature shown on pricing tables or not | string | Options are 'public' or 'private' | |
valueType | Identifies the type of value the variable will have | string | Options are 'boolean', 'numerical', or 'enum' | |
defaultValue | Identifies the default option for the feature | string | ||
showUnlimited | Identifies if the feature is set to unlimited | boolean | ||
productUuid | UUID of the product | string | ||
updatedAt | Date and time the feature was last updated in ISO 8601 and Coordinated Universal Time (UTC) | string | The format is: YYYY-MM-DDThh: mm:ss.sssZ | |
featureEnumOptions | Lists the options for features with the Enum type | array of objects | ||
uuid | UUID of the option for the feature | string | ||
name | The description/name of the feature option given in the Salable Dashboard | string | ||
featureUuid | The UUID for the feature | string | ||
updatedAt | Date and time the value was last updated in ISO 8601 and Coordinated Universal Time (UTC) | string | The format is: YYYY-MM-DDThh: mm:ss.sssZ |
Sample Response
[
{
"uuid": "143fdae7-a77d-4608-ab70-8ab89fafe9bc",
"name": "true/false",
"description": "",
"displayName": "Feature 3",
"variableName": "truefalse",
"status": "ACTIVE",
"visibility": "public",
"valueType": "boolean",
"defaultValue": "true",
"showUnlimited": false,
"productUuid": "e6d24c05-6ceb-46af-8168-2eea7f35e252",
"updatedAt": "2022-08-18T18:27:51.675Z",
"featureEnumOptions": []
},
{
"uuid": "2cf5f0f2-ea92-48f4-8b26-b1616cd2b7d2",
"name": "thing 1",
"description": "nnnnn",
"displayName": "Thing 2",
"variableName": "thing_",
"status": "ACTIVE",
"visibility": "public",
"valueType": "numerical",
"defaultValue": "10",
"showUnlimited": false,
"productUuid": "e6d24c05-6ceb-46af-8168-2eea7f35e252",
"updatedAt": "2022-07-14T13:17:32.635Z",
"featureEnumOptions": []
},
{
"uuid": "f419276d-d235-4c70-953b-13d85b73daec",
"name": "thing 2 ",
"description": "nnnmmkmkm",
"displayName": "2",
"variableName": "thing_2_",
"status": "ACTIVE",
"visibility": "public",
"valueType": "enum",
"defaultValue": "Option 2",
"showUnlimited": false,
"productUuid": "e6d24c05-6ceb-46af-8168-2eea7f35e252",
"updatedAt": "2022-07-14T13:18:26.895Z",
"featureEnumOptions": [
{
"uuid": "0c4285ed-6bf3-41ad-bfd7-b3fb582f0adb",
"name": "Option 1",
"featureUuid": "f419276d-d235-4c70-953b-13d85b73daec",
"updatedAt": "2022-07-14T13:18:27.000Z"
},
{
"uuid": "2f815233-1ea2-49d5-b03e-84d13327f5d4",
"name": "Option 2",
"featureUuid": "f419276d-d235-4c70-953b-13d85b73daec",
"updatedAt": "2022-07-14T13:18:27.000Z"
},
{
"uuid": "8cee857f-de91-4b7c-b400-2f0915cfde17",
"name": "Option 3",
"featureUuid": "f419276d-d235-4c70-953b-13d85b73daec",
"updatedAt": "2022-07-14T13:18:27.000Z"
}
]
}
]