---
agentTools:
  projectIndex: https://cmai.readme.io/llms.txt
---

# Get a list of shop text entities

Get a list of shop text entities.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "version": "1.3.39",
    "title": "Conversion Maker AI API",
    "termsOfService": "https://conversionmaker.ai/agb/",
    "description": "This is the public API description of Conversion Maker AI. A project with an active plan is required to use the API. The API Key and the ID of the project can be found in the project settings.\n",
    "contact": {
      "email": "helpdesk@conversionmaker.ai",
      "name": "Conversion Maker AI",
      "url": "https://conversionmaker.ai"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "servers": [
    {
      "url": "https://app.conversionmaker.ai/api/v1",
      "description": "production"
    },
    {
      "url": "https://app.stage.conversionmaker.ai/api/v1",
      "description": "preview"
    },
    {
      "url": "http://localhost:3000/api/v1",
      "description": "development"
    }
  ],
  "tags": [
    {
      "name": "Shop Texts",
      "description": "To CRUD product entities"
    }
  ],
  "paths": {
    "/products": {
      "get": {
        "tags": [
          "Shop Texts"
        ],
        "summary": "Get a list of shop text entities",
        "description": "Get a list of shop text entities.",
        "operationId": "getProducts",
        "parameters": [
          {
            "$ref": "#/components/parameters/projectId"
          },
          {
            "$ref": "#/components/parameters/q"
          },
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/sort"
          },
          {
            "$ref": "#/components/parameters/fields"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "integer",
                      "format": "int32",
                      "example": 200,
                      "description": "The response status code"
                    },
                    "message": {
                      "type": "string",
                      "example": "OK",
                      "description": "The description of the response status code"
                    },
                    "data": {
                      "type": "object",
                      "properties": {
                        "results": {
                          "type": "array",
                          "items": {
                            "$ref": "#/components/schemas/Product"
                          }
                        },
                        "total": {
                          "type": "integer",
                          "format": "int32",
                          "example": 2308,
                          "description": "Number of data records matching the filter query"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "402": {
            "$ref": "#/components/responses/402"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "405": {
            "$ref": "#/components/responses/405"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        },
        "security": [
          {
            "ApiKeyAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "parameters": {
      "projectId": {
        "name": "projectId",
        "in": "query",
        "description": "The project ID",
        "required": true,
        "example": "6282171639dac8dfb01c44a0",
        "schema": {
          "type": "string",
          "minLength": 24,
          "maxLength": 24
        }
      },
      "q": {
        "name": "q",
        "in": "query",
        "description": "The filter query (mongodb syntax)",
        "example": {
          "title": "foo"
        },
        "schema": {
          "type": "string",
          "format": "json"
        }
      },
      "perPage": {
        "name": "perPage",
        "in": "query",
        "description": "Number of results per page",
        "example": 50,
        "schema": {
          "type": "integer",
          "format": "int32",
          "maximum": 100,
          "minimum": 1,
          "default": 50
        }
      },
      "page": {
        "name": "page",
        "in": "query",
        "description": "Page index of the results to return. First page is 0.",
        "example": 0,
        "schema": {
          "type": "integer",
          "format": "int32",
          "minimum": 0,
          "default": 0
        }
      },
      "sort": {
        "name": "sort",
        "in": "query",
        "description": "Comma separated list of fields to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1",
        "example": "title:-1,updateDate:1",
        "schema": {
          "type": "string"
        }
      },
      "fields": {
        "name": "fields",
        "in": "query",
        "description": "Comma-separated list of fields to include in the result. Leave empty to retrieve all fields.",
        "example": "title,updateDate,content",
        "schema": {
          "type": "string"
        }
      }
    },
    "responses": {
      "400": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "message",
                "code"
              ],
              "properties": {
                "status": {
                  "type": "integer",
                  "description": "The response status code",
                  "example": 400
                },
                "message": {
                  "type": "string",
                  "description": "The response status message",
                  "example": "Bad Request"
                },
                "code": {
                  "type": "integer",
                  "description": "The internal error code",
                  "example": 1669810156
                },
                "data": {
                  "type": "object",
                  "description": "Any additional information regarding the error"
                }
              }
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "message",
                "code"
              ],
              "properties": {
                "status": {
                  "type": "integer",
                  "description": "The response status code",
                  "example": 401
                },
                "message": {
                  "type": "string",
                  "description": "The response status message",
                  "example": "Unauthorized"
                },
                "code": {
                  "type": "integer",
                  "description": "The internal error code",
                  "example": 1669810156
                }
              }
            }
          }
        }
      },
      "402": {
        "description": "Payment required",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "message",
                "code"
              ],
              "properties": {
                "status": {
                  "type": "integer",
                  "description": "The response status code",
                  "example": 402
                },
                "message": {
                  "type": "string",
                  "description": "The response status message",
                  "example": "Payment required"
                },
                "code": {
                  "type": "integer",
                  "description": "The internal error code",
                  "example": 1669810156
                }
              }
            }
          }
        }
      },
      "403": {
        "description": "Forbidden",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "message",
                "code"
              ],
              "properties": {
                "status": {
                  "type": "integer",
                  "description": "The response status code",
                  "example": 403
                },
                "message": {
                  "type": "string",
                  "description": "The response status message",
                  "example": "Forbidden"
                },
                "code": {
                  "type": "integer",
                  "description": "The internal error code",
                  "example": 1669810156
                }
              }
            }
          }
        }
      },
      "405": {
        "description": "Method not allowed",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "message",
                "code",
                "data"
              ],
              "properties": {
                "status": {
                  "type": "integer",
                  "description": "The response status code",
                  "example": 405
                },
                "message": {
                  "type": "string",
                  "description": "The response status message",
                  "example": "Method not allowed"
                },
                "code": {
                  "type": "integer",
                  "description": "The internal error code",
                  "example": 1669810156
                },
                "data": {
                  "type": "object",
                  "properties": {
                    "allowedMethods": {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "description": "The allowed HTTP request methods",
                        "example": "POST"
                      }
                    }
                  }
                }
              }
            }
          }
        }
      },
      "429": {
        "description": "Too many requests",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "status",
                "message",
                "code"
              ],
              "properties": {
                "status": {
                  "type": "integer",
                  "description": "The response status code",
                  "example": 429
                },
                "message": {
                  "type": "string",
                  "description": "The response status message",
                  "example": "Too many requests"
                },
                "code": {
                  "type": "integer",
                  "description": "The internal error code",
                  "example": 1669810156
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    },
    "schemas": {
      "FormOfAddress": {
        "type": "string",
        "enum": [
          "FORMAL",
          "INFORMAL",
          "INFORMAL_LOWERCASE",
          "NEUTRAL",
          "PLURAL_INFORMAL",
          "PLURAL_FORMAL"
        ],
        "description": "If omitted the AI will tend to keep the form of address as seen in the given inputs. Only available for da-DK, fr-FR, de-DE, de-AT, de-CH, it-IT, pl-Pl, pt-PT, es-ES, ru-RU, cs-CZ. The form of address in other languages are not supported and will result in an error.\n\nINFORMAL_LOWERCASE is only available for: \n\n* de-DE\n\n* de-AT\n\n* de-CH\n"
      },
      "ImportState": {
        "type": "string",
        "enum": [
          "NEW",
          "ANALYZING_NEW",
          "ANALYZING_LOCAL_NEW",
          "PENDING",
          "ANALYZING_PENDING",
          "ANALYZING_LOCAL_PENDING",
          "FINISHED",
          "FAILED"
        ],
        "default": "NEW"
      },
      "ShopTextType": {
        "type": "string",
        "enum": [
          "PRODUCT-PAGE",
          "SHOP-CATEGORY"
        ],
        "default": "PRODUCT-PAGE"
      },
      "LanguageCode": {
        "type": "string",
        "enum": [
          "bg-BG",
          "cs-CZ",
          "da-DK",
          "de-AT",
          "de-CH",
          "de-DE",
          "el-GR",
          "en-GB",
          "en-US",
          "es-ES",
          "et-EE",
          "fi-FI",
          "fr-FR",
          "hu-HU",
          "id-ID",
          "it-IT",
          "ja-JP",
          "ko-KR",
          "lt-LT",
          "lv-LV",
          "nb-NO",
          "nl-NL",
          "pl-PL",
          "pt-BR",
          "pt-PT",
          "ro-RO",
          "ru-RU",
          "sk-SK",
          "sl-SI",
          "sv-SE",
          "tr-TR",
          "uk-UA"
        ],
        "default": "de-DE"
      },
      "Product": {
        "type": "object",
        "properties": {
          "_id": {
            "type": "string"
          },
          "_projectId": {
            "type": "string"
          },
          "_categoryId": {
            "type": "string"
          },
          "createDate": {
            "type": "string",
            "format": "date-time"
          },
          "updateDate": {
            "type": "string",
            "format": "date-time"
          },
          "overallScore": {
            "type": "integer",
            "format": "int32",
            "minimum": 0,
            "maximum": 100
          },
          "title": {
            "type": "string",
            "maxLength": 250
          },
          "languageCode": {
            "$ref": "#/components/schemas/LanguageCode"
          },
          "importState": {
            "$ref": "#/components/schemas/ImportState"
          },
          "type": {
            "$ref": "#/components/schemas/ShopTextType"
          },
          "content": {
            "type": "object",
            "properties": {
              "text": {
                "type": "string"
              },
              "metaTitle": {
                "type": "string"
              },
              "metaDescription": {
                "type": "string"
              }
            }
          },
          "input": {
            "type": "object",
            "properties": {
              "formOfAddress": {
                "$ref": "#/components/schemas/FormOfAddress"
              },
              "keywords": {
                "type": "string"
              },
              "name": {
                "type": "string"
              },
              "properties": {
                "type": "string"
              },
              "textLength": {
                "type": "string"
              },
              "xoviInput": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "externalDocs": {
    "url": "https://cmai.readme.io/"
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 106,
      "1": 130,
      "2": 200,
      "3": 239,
      "4": 192,
      "5": 46,
      "6": 118,
      "7": 90,
      "8": 69,
      "9": 252,
      "10": 178,
      "11": 217
    }
  }
}
```