List Products

The whole product dictionary, unpaginated — a handful of documents that the filter pickers and the product admin both read on load.

Cached under one key for everyone: no query params, and the answer never varies by caller. Every write in this router drops the tag, so the TTL is only the backstop for a change made outside the API.

GET/api/v1/products

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Responses

200Successful Response

successboolean

default: true

dataProduct[] | any

Show properties

Any of:

Product[]

Array of Product

idstringrequired

schema_versioninteger

default: 1

namestringrequired

analytics_keystring | any

Show properties

Any of:

string

string

any

any

dictionariesobject

subtopics_by_topicobject

created_atstring<date-time>

updated_atstring<date-time>

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

Request

curl -X GET "/api/v1/products" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/products", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/products",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": [
    {
      "id": "string",
      "schema_version": 1,
      "name": "string",
      "analytics_key": "string",
      "dictionaries": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "subtopics_by_topic": {
        "property1": [
          "string"
        ],
        "property2": [
          "string"
        ]
      },
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "message": "string",
  "errors": [
    "string"
  ]
}