Skip to main content
GET
/
v1
/
products
List Products
curl --request GET \
  --url https://api.withflex.com/v1/products \
  --header 'Authorization: Bearer <token>'
{
  "products": [
    {
      "product_id": "obj_01EXAMPLE00000000000000000",
      "name": "Example",
      "description": "string",
      "document_description": "string",
      "receipt_description": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "visit_type": "cbtSleep",
      "active": false,
      "upc_code": "string",
      "gtin": "string",
      "reference_gtin": "string",
      "hsa_fsa_eligibility": "not_eligible",
      "test_mode": false,
      "metadata": {},
      "url": "https://example.com",
      "client_reference_id": "obj_01EXAMPLE00000000000000000"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.withflex.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use a Bearer token to access this API.

Query Parameters

​
limit
integer<int32> | null

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Required range: x >= 1
Example:

10

​
offset
integer<int32> | null

Number of objects to skip before returning results.

Required range: x >= 0
Example:

0

​
starting_after
string | null

A cursor for use in pagination. starting_after is a product ID that defines your place in the list.

Example:

"obj_01EXAMPLE00000000000000000"

​
ending_before
string | null

A cursor for use in pagination. ending_before is a product ID that defines your place in the list.

Example:

"obj_01EXAMPLE00000000000000000"

​
active
boolean | null

Only return products where active matches this value.

Example:

false

​
client_reference_id
string | null

Filter products by their client-provided product identifier.

Example:

"string"

​
metadata
object

Filter by metadata key-value pairs using bracket syntax. For example: metadata[lookup_key]=premium-plan. Multiple keys use AND logic.

Example:
{ "lookup_key": "premium-plan" }

Response

Success

​
products
object[]
required