Skip to main content

List Products

Search and paginate through your account's product catalog. Use this to discover the product names you need to pass to add_products in the upsert-lead request.

List-only via API

Only listing products is supported via API. To create, edit, or delete products, use the Superfone dashboard.

Authentication Required

Requires the x-api-key header. See Overview for details.

HTTP Request

GET /enterprise/api/product

Query Parameters

ParameterTypeRequiredDefaultDescription
textstringNoCase-insensitive substring filter on the product title
pagenumberNo1Page number — starts at 1, not 0
page_sizenumberNo50Items per page

Try it

Loading playground…

Code Examples

curl -X GET "https://prod-api.superfone.co.in/superfone/enterprise/api/product?text=starter" \
-H "x-api-key: your_api_key_here"

Success Response

Status Code: 200 OK

{
"data": {
"rows": [
{
"id": 5,
"org_id": 42,
"title": "Starter Plan",
"description": "Entry-level subscription, billed monthly.",
"status": "ACTIVE",
"price": 999,
"currency": "INR",
"link": "https://example.com/plans/starter",
"images": {},
"created_by": 678,
"updated_by": null,
"created_at": "2026-02-01T09:00:00.000Z",
"updated_at": "2026-02-01T09:00:00.000Z"
}
],
"total_pages": 1,
"current_page": 1,
"page_size": 50,
"total_items": 1
},
"message": "success"
}

Response Fields

FieldTypeDescription
data.rows[].idnumberInternal product ID
data.rows[].titlestringProduct name — this is the value to pass in add_products
data.rows[].descriptionstring | nullProduct description
data.rows[].statusstringACTIVE or DISABLED
data.rows[].pricenumberPrice
data.rows[].currencystringISO 4217 currency code (e.g. INR)
data.rows[].linkstring | nullOptional product URL
data.rows[].imagesobjectImage metadata (JSON object)
data.rows[].created_atstringISO 8601 timestamp
data.rows[].updated_atstringISO 8601 timestamp

Error Responses

StatusMessageWhen it occurs
401UnAuthorized, Please Provide Valid API KeyMissing or invalid x-api-key