Get Product
Get detailed configuration data for a specific product, including description, optimization notes, team members, and quality index metric weights. Available on all plans.
GET
/
products
/
{productId}
cURL
curl --request GET \
--url https://www.greenflash.ai/api/v1/products/{productId} \
--header 'Authorization: Bearer <token>'import os
from greenflash import Greenflash
client = Greenflash(
api_key=os.environ.get("GREENFLASH_API_KEY"), # This is the default and can be omitted
)
get_product_response = client.products.get(
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(get_product_response.id)import Greenflash from 'greenflash';
const client = new Greenflash({
apiKey: process.env['GREENFLASH_API_KEY'], // This is the default and can be omitted
});
const getProductResponse = await client.products.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(getProductResponse.id);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.greenflash.ai/api/v1/products/{productId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.greenflash.ai/api/v1/products/{productId}")
.header("Authorization", "Bearer <token>")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.greenflash.ai/api/v1/products/{productId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Customer Support Bot",
"icon": "headset",
"color": "#4F46E5",
"description": "AI-powered customer support chatbot for the main website. Handles billing inquiries, product questions, and account management.",
"optimizationNotes": "Focus on reducing hallucination in refund policy answers. Ensure the bot always links to the latest pricing page.",
"userPrivacy": "standard",
"members": [
{
"id": "789e4567-e89b-12d3-a456-426614174010",
"userId": "user_abc123",
"role": "owner",
"avatarUrl": "https://img.clerk.com/abc123"
},
{
"id": "789e4567-e89b-12d3-a456-426614174011",
"userId": "user_def456",
"role": "member",
"avatarUrl": null
}
],
"qualityIndexMetricWeights": [
{
"key": "satisfaction",
"weight": 0.35,
"name": "Satisfaction",
"description": "Overall customer satisfaction score."
},
{
"key": "safety",
"weight": 0.3,
"name": "Safety",
"description": "Safety and compliance adherence."
},
{
"key": "friction",
"weight": 0.2,
"name": "Friction",
"description": "User friction and struggle indicators."
},
{
"key": "growth",
"weight": 0.15,
"name": "Growth",
"description": "Growth and commercial intent metrics."
}
],
"createdAt": "2025-06-15T10:00:00Z",
"updatedAt": "2025-10-01T14:30:00Z"
}{
"success": false,
"error": "Product not found"
}{
"success": true,
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The product ID to retrieve
Response
Product retrieved successfully
The product ID.
The product name.
Product icon identifier.
Product color hex code.
Product description.
AI optimization notes for the product.
User privacy setting.
Product team members.
Show child attributes
Show child attributes
Quality index metric weight configuration.
Show child attributes
Show child attributes
When the product was created (ISO 8601).
When the product was last updated (ISO 8601).
Was this page helpful?
⌘I
cURL
curl --request GET \
--url https://www.greenflash.ai/api/v1/products/{productId} \
--header 'Authorization: Bearer <token>'import os
from greenflash import Greenflash
client = Greenflash(
api_key=os.environ.get("GREENFLASH_API_KEY"), # This is the default and can be omitted
)
get_product_response = client.products.get(
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(get_product_response.id)import Greenflash from 'greenflash';
const client = new Greenflash({
apiKey: process.env['GREENFLASH_API_KEY'], // This is the default and can be omitted
});
const getProductResponse = await client.products.get('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');
console.log(getProductResponse.id);package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://www.greenflash.ai/api/v1/products/{productId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://www.greenflash.ai/api/v1/products/{productId}")
.header("Authorization", "Bearer <token>")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.greenflash.ai/api/v1/products/{productId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Customer Support Bot",
"icon": "headset",
"color": "#4F46E5",
"description": "AI-powered customer support chatbot for the main website. Handles billing inquiries, product questions, and account management.",
"optimizationNotes": "Focus on reducing hallucination in refund policy answers. Ensure the bot always links to the latest pricing page.",
"userPrivacy": "standard",
"members": [
{
"id": "789e4567-e89b-12d3-a456-426614174010",
"userId": "user_abc123",
"role": "owner",
"avatarUrl": "https://img.clerk.com/abc123"
},
{
"id": "789e4567-e89b-12d3-a456-426614174011",
"userId": "user_def456",
"role": "member",
"avatarUrl": null
}
],
"qualityIndexMetricWeights": [
{
"key": "satisfaction",
"weight": 0.35,
"name": "Satisfaction",
"description": "Overall customer satisfaction score."
},
{
"key": "safety",
"weight": 0.3,
"name": "Safety",
"description": "Safety and compliance adherence."
},
{
"key": "friction",
"weight": 0.2,
"name": "Friction",
"description": "User friction and struggle indicators."
},
{
"key": "growth",
"weight": 0.15,
"name": "Growth",
"description": "Growth and commercial intent metrics."
}
],
"createdAt": "2025-06-15T10:00:00Z",
"updatedAt": "2025-10-01T14:30:00Z"
}{
"success": false,
"error": "Product not found"
}{
"success": true,
"error": "<string>"
}
