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

curl --request GET \
  --url https://www.greenflash.ai/api/v1/products/{productId} \
  --header 'Authorization: Bearer <token>'

200

{
  "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"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

productId · string<uuid> · required

The product ID to retrieve

Response

200

application/json

Product retrieved successfully

id · string<uuid> · required

The product ID.

name · string · required

The product name.

icon · string | null · required

Product icon identifier.

color · string | null · required

Product color hex code.

description · string | null · required

Product description.

optimizationNotes · string | null · required

AI optimization notes for the product.

userPrivacy · string · required

User privacy setting.

members · object[] · required

Product team members.

Show child attributes

qualityIndexMetricWeights · object[] · required

Quality index metric weight configuration.

Show child attributes

createdAt · string · required

When the product was created (ISO 8601).

updatedAt · string · required

When the product was last updated (ISO 8601).