---
id: list-app-variants
title: "List App Variants"
description: "Retrieve a list of app variants for a given app ID."
sidebar_label: "List App Variants"
hide_title: true
hide_table_of_contents: true
api: eJztVktv4zYQ/iuELnUAw06DnnSqkyy6QXe7QV49JIbBSCOZG5nUkpRbr+H/3hk+ZCle29sNeqsvpshv3vMNuU4sL02SPiaTujbJdJjkYDItaiuUTNLkBqwWsATGWSWMZapgvK7ZkmvBpTWsUBqPSrEE6Q6uLkdP8klOdGnSJ8nwh7szkbOBsfokZXdzQAypsbgiCauYjka6akde3Fj1AnJmwBj0iA1u/eJCScuFBD1kyvnKq6A9IrOIIAtL0KJYOZuNAf2TibARu4SCNxXaRNgl1CBzM/DwaHRwcuKCwlw0Wsa4PmA6HjFpD97nGzC1kgamKZvsTxU50EtWMkxUDZpTCFc5JpxEZ5SzKIeImmu+AAuaCrVOJH4g0icWjwUVquZ2jmsNXxqhATVZ3cAwMdkcFjxJ14ld1SSFZRCyRKQVtqKNCTmSJ5vNlKR9EIYEzk5P6a/fD7dNlmFWiqZiMWLURbkGaQmOXlUic/GMPxuSWe86wbXmK/LcwsLZqjVlwQpvOUT2HU4PHdYn5DD6D8IgPqT1iP5Q1GAjyhyzE6WiLYzqM2THbF17VLDVrTVmQq4+Fa7oQVo9ExaB7Y5sqiqh4rX6thpQ3zM3cNTxcwS1XjuJwy47vPcXS1+I8qiFCwdrbTRafDO8IHcovHsU3VCrLoURvr8CVGATlqA7Vm8iiBzVwC3kM25/1PKF18Am1oVQ52/Ud+81BH0LlYtCoMLnVcj+j+j8GLSw81UokNIll+KrY+QbFH/qqAma/1L6xdQ8gzeo/TPq8DNo+KrPuwPtcTvxWtL3+PyKqD3+9YjVZcW23/u97Hu002fT3jx5NfVnlI9t1/lNd0UwGj4PcZZvNhTjL2dnu5P1gVci9+l9p7XS/2as9sdnDnjxVbTaM18rlfVOv6NwkVub6bZGcYrHuD8o76DrZlMeGgcf8Q7hpRsFHrIf6pLB7uj0WH9QXN50wE27szmm12d3fxiXPn3fMhYh7+/urncU+tpii80VXeQlWNd1eC2nyRjrZ8Zr38Cbcedux9fIMl7sjcaqJXNra5OOx1mlmnyEWcJ3zIgLVEH92G+aiTtlFwR1vDKQYd/aldM3ub76HVbvgedYufRx2gXcUvP4dujDtpd0LXAbTYb3xqTByHQYAfHZMfdSFLmQhXLikSXet3Oe4QPOsRPj9G6fjn4ene4LJggwdCtwgGeOA9EPB3ME7aarTRSeIC2IAIkFvvh1e0Be1srYBZcdfbssfeXYekvE/9/D//17OLSfhb/tuK7QZf9gcAPN08ndBFSmtL0RWkZhi8+xxARar2m03+tqs6HtLw1o4sU0oJ+pS5EluTC0Rs4WvDJwoPiDmzBsTtg+PyN35Mo5VTX0hcsXZFL7ZHdDdB5puQ6HE3xZ17YjtjPzib/tfPnt3R029D/3HrS5
sidebar_class_name: "get api-method"
info_path: reference/api/agenta-backend
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading as={"h1"} className={"openapi__heading"} children={"List App Variants"}></Heading>

<MethodEndpoint method={"get"} path={"/apps/{app_id}/variants"}></MethodEndpoint>

Retrieve a list of app variants for a given app ID.

Args:
app_id (str): The ID of the app to retrieve variants for.
stoken_session (SessionContainer, optional): The session container to verify the user's session. Defaults to Depends(verify_session()).

Returns:
List[AppVariantResponse]: A list of app variants for the given app ID.

<Heading id={"request"} as={"h2"} className={"openapi-tabs__heading"} children={"Request"}></Heading>

<details style={{ marginBottom: "1rem" }} className={"openapi-markdown__details"} data-collapsed={false} open={true}>
  <summary style={{}}>
    <h3 className={"openapi-markdown__details-summary-header-params"}>Path Parameters</h3>
  </summary>
  <div>
    <ul>
      <ParamsItem
        className={"paramsItem"}
        param={{ name: "app_id", in: "path", required: true, schema: { type: "string", title: "App Id" } }}
      ></ParamsItem>
    </ul>
  </div>
</details>
<div>
  <div>
    <ApiTabs label={undefined} id={undefined}>
      <TabItem label={"200"} value={"200"}>
        <div>Successful Response</div>
        <div>
          <MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}>
            <TabItem label={"application/json"} value={"application/json"}>
              <SchemaTabs className={"openapi-tabs__schema"}>
                <TabItem label={"Schema"} value={"Schema"}>
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary style={{}} className={"openapi-markdown__details-summary-response"}>
                      <strong>Schema</strong>
                    </summary>
                    <div style={{ textAlign: "left", marginLeft: "1rem" }}></div>
                    <ul style={{ marginLeft: "1rem" }}>
                      <li>
                        <div
                          style={{
                            fontSize: "var(--ifm-code-font-size)",
                            opacity: "0.6",
                            marginLeft: "-.5rem",
                            paddingBottom: ".5rem",
                          }}
                        >
                          Array [
                        </div>
                      </li>
                      <SchemaItem
                        collapsible={false}
                        name={"app_id"}
                        required={true}
                        schemaName={"App Id (string)"}
                        qualifierMessage={undefined}
                        schema={{ type: "string", title: "App Id" }}
                      ></SchemaItem>
                      <SchemaItem
                        collapsible={false}
                        name={"app_name"}
                        required={true}
                        schemaName={"App Name (string)"}
                        qualifierMessage={undefined}
                        schema={{ type: "string", title: "App Name" }}
                      ></SchemaItem>
                      <SchemaItem
                        collapsible={false}
                        name={"variant_id"}
                        required={true}
                        schemaName={"Variant Id (string)"}
                        qualifierMessage={undefined}
                        schema={{ type: "string", title: "Variant Id" }}
                      ></SchemaItem>
                      <SchemaItem
                        collapsible={false}
                        name={"variant_name"}
                        required={true}
                        schemaName={"Variant Name (string)"}
                        qualifierMessage={undefined}
                        schema={{ type: "string", title: "Variant Name" }}
                      ></SchemaItem>
                      <SchemaItem
                        collapsible={false}
                        name={"project_id"}
                        required={true}
                        schemaName={"Project Id (string)"}
                        qualifierMessage={undefined}
                        schema={{ type: "string", title: "Project Id" }}
                      ></SchemaItem>
                      <SchemaItem collapsible={true} className={"schemaItem"}>
                        <details style={{}} className={"openapi-markdown__details"}>
                          <summary style={{}}>
                            <strong>parameters</strong>
                            <span style={{ opacity: "0.6" }}>object</span>
                            <strong style={{ fontSize: "var(--ifm-code-font-size)", color: "var(--openapi-required)" }}>
                              required
                            </strong>
                          </summary>
                          <div style={{ marginLeft: "1rem" }}></div>
                          <div>
                            <span className={"badge badge--info"}>anyOf</span>
                          </div>
                        </details>
                      </SchemaItem>
                      <SchemaItem
                        collapsible={false}
                        name={"base_name"}
                        required={true}
                        schemaName={"Base Name (string)"}
                        qualifierMessage={undefined}
                        schema={{ type: "string", title: "Base Name" }}
                      ></SchemaItem>
                      <SchemaItem
                        collapsible={false}
                        name={"base_id"}
                        required={true}
                        schemaName={"Base Id (string)"}
                        qualifierMessage={undefined}
                        schema={{ type: "string", title: "Base Id" }}
                      ></SchemaItem>
                      <SchemaItem
                        collapsible={false}
                        name={"config_name"}
                        required={true}
                        schemaName={"Config Name (string)"}
                        qualifierMessage={undefined}
                        schema={{ type: "string", title: "Config Name" }}
                      ></SchemaItem>
                      <SchemaItem collapsible={true} className={"schemaItem"}>
                        <details style={{}} className={"openapi-markdown__details"}>
                          <summary style={{}}>
                            <strong>uri</strong>
                            <span style={{ opacity: "0.6" }}>object</span>
                            <strong style={{ fontSize: "var(--ifm-code-font-size)", color: "var(--openapi-required)" }}>
                              required
                            </strong>
                          </summary>
                          <div style={{ marginLeft: "1rem" }}></div>
                          <div>
                            <span className={"badge badge--info"}>anyOf</span>
                            <SchemaTabs>
                              <TabItem label={"MOD1"} value={"0-item-properties"}>
                                <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>string</div>
                              </TabItem>
                            </SchemaTabs>
                          </div>
                        </details>
                      </SchemaItem>
                      <SchemaItem
                        collapsible={false}
                        name={"revision"}
                        required={true}
                        schemaName={"Revision (integer)"}
                        qualifierMessage={undefined}
                        schema={{ type: "integer", title: "Revision" }}
                      ></SchemaItem>
                      <SchemaItem collapsible={true} className={"schemaItem"}>
                        <details style={{}} className={"openapi-markdown__details"}>
                          <summary style={{}}>
                            <strong>created_at</strong>
                            <span style={{ opacity: "0.6" }}>object</span>
                          </summary>
                          <div style={{ marginLeft: "1rem" }}></div>
                          <div>
                            <span className={"badge badge--info"}>anyOf</span>
                            <SchemaTabs>
                              <TabItem label={"MOD1"} value={"0-item-properties"}>
                                <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>string</div>
                              </TabItem>
                            </SchemaTabs>
                          </div>
                        </details>
                      </SchemaItem>
                      <SchemaItem collapsible={true} className={"schemaItem"}>
                        <details style={{}} className={"openapi-markdown__details"}>
                          <summary style={{}}>
                            <strong>updated_at</strong>
                            <span style={{ opacity: "0.6" }}>object</span>
                          </summary>
                          <div style={{ marginLeft: "1rem" }}></div>
                          <div>
                            <span className={"badge badge--info"}>anyOf</span>
                            <SchemaTabs>
                              <TabItem label={"MOD1"} value={"0-item-properties"}>
                                <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>string</div>
                              </TabItem>
                            </SchemaTabs>
                          </div>
                        </details>
                      </SchemaItem>
                      <SchemaItem collapsible={true} className={"schemaItem"}>
                        <details style={{}} className={"openapi-markdown__details"}>
                          <summary style={{}}>
                            <strong>modified_by_id</strong>
                            <span style={{ opacity: "0.6" }}>object</span>
                          </summary>
                          <div style={{ marginLeft: "1rem" }}></div>
                          <div>
                            <span className={"badge badge--info"}>anyOf</span>
                            <SchemaTabs>
                              <TabItem label={"MOD1"} value={"0-item-properties"}>
                                <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>string</div>
                              </TabItem>
                            </SchemaTabs>
                          </div>
                        </details>
                      </SchemaItem>
                      <SchemaItem collapsible={true} className={"schemaItem"}>
                        <details style={{}} className={"openapi-markdown__details"}>
                          <summary style={{}}>
                            <strong>organization_id</strong>
                            <span style={{ opacity: "0.6" }}>object</span>
                          </summary>
                          <div style={{ marginLeft: "1rem" }}></div>
                          <div>
                            <span className={"badge badge--info"}>anyOf</span>
                            <SchemaTabs>
                              <TabItem label={"MOD1"} value={"0-item-properties"}>
                                <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>string</div>
                              </TabItem>
                            </SchemaTabs>
                          </div>
                        </details>
                      </SchemaItem>
                      <SchemaItem collapsible={true} className={"schemaItem"}>
                        <details style={{}} className={"openapi-markdown__details"}>
                          <summary style={{}}>
                            <strong>workspace_id</strong>
                            <span style={{ opacity: "0.6" }}>object</span>
                          </summary>
                          <div style={{ marginLeft: "1rem" }}></div>
                          <div>
                            <span className={"badge badge--info"}>anyOf</span>
                            <SchemaTabs>
                              <TabItem label={"MOD1"} value={"0-item-properties"}>
                                <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>string</div>
                              </TabItem>
                            </SchemaTabs>
                          </div>
                        </details>
                      </SchemaItem>
                      <li>
                        <div style={{ fontSize: "var(--ifm-code-font-size)", opacity: "0.6", marginLeft: "-.5rem" }}>
                          ]
                        </div>
                      </li>
                    </ul>
                  </details>
                </TabItem>
                <TabItem label={"Example (from schema)"} value={"Example (from schema)"}>
                  <ResponseSamples
                    responseExample={
                      '[\n  {\n    "app_id": "string",\n    "app_name": "string",\n    "variant_id": "string",\n    "variant_name": "string",\n    "project_id": "string",\n    "parameters": {},\n    "base_name": "string",\n    "base_id": "string",\n    "config_name": "string",\n    "uri": "string",\n    "revision": 0,\n    "created_at": "string",\n    "updated_at": "string",\n    "modified_by_id": "string",\n    "organization_id": "string",\n    "workspace_id": "string"\n  }\n]'
                    }
                    language={"json"}
                  ></ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
      <TabItem label={"422"} value={"422"}>
        <div>Validation Error</div>
        <div>
          <MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}>
            <TabItem label={"application/json"} value={"application/json"}>
              <SchemaTabs className={"openapi-tabs__schema"}>
                <TabItem label={"Schema"} value={"Schema"}>
                  <details
                    style={{}}
                    className={"openapi-markdown__details response"}
                    data-collapsed={false}
                    open={true}
                  >
                    <summary style={{}} className={"openapi-markdown__details-summary-response"}>
                      <strong>Schema</strong>
                    </summary>
                    <div style={{ textAlign: "left", marginLeft: "1rem" }}></div>
                    <ul style={{ marginLeft: "1rem" }}>
                      <SchemaItem collapsible={true} className={"schemaItem"}>
                        <details style={{}} className={"openapi-markdown__details"}>
                          <summary style={{}}>
                            <span className={"openapi-schema__container"}>
                              <strong className={"openapi-schema__property"}>detail</strong>
                              <span className={"openapi-schema__name"}>object[]</span>
                            </span>
                          </summary>
                          <div style={{ marginLeft: "1rem" }}>
                            <li>
                              <div
                                style={{
                                  fontSize: "var(--ifm-code-font-size)",
                                  opacity: "0.6",
                                  marginLeft: "-.5rem",
                                  paddingBottom: ".5rem",
                                }}
                              >
                                Array [
                              </div>
                            </li>
                            <SchemaItem collapsible={true} className={"schemaItem"}>
                              <details style={{}} className={"openapi-markdown__details"}>
                                <summary style={{}}>
                                  <span className={"openapi-schema__container"}>
                                    <strong className={"openapi-schema__property"}>loc</strong>
                                    <span className={"openapi-schema__name"}>object[]</span>
                                    <span className={"openapi-schema__divider"}></span>
                                    <span className={"openapi-schema__required"}>required</span>
                                  </span>
                                </summary>
                                <div style={{ marginLeft: "1rem" }}>
                                  <li>
                                    <div
                                      style={{
                                        fontSize: "var(--ifm-code-font-size)",
                                        opacity: "0.6",
                                        marginLeft: "-.5rem",
                                        paddingBottom: ".5rem",
                                      }}
                                    >
                                      Array [
                                    </div>
                                  </li>
                                  <div>
                                    <span className={"badge badge--info"}>anyOf</span>
                                    <SchemaTabs>
                                      <TabItem label={"MOD1"} value={"0-item-properties"}>
                                        <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>string</div>
                                      </TabItem>
                                      <TabItem label={"MOD2"} value={"1-item-properties"}>
                                        <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>integer</div>
                                      </TabItem>
                                    </SchemaTabs>
                                  </div>
                                  <li>
                                    <div
                                      style={{
                                        fontSize: "var(--ifm-code-font-size)",
                                        opacity: "0.6",
                                        marginLeft: "-.5rem",
                                      }}
                                    >
                                      ]
                                    </div>
                                  </li>
                                </div>
                              </details>
                            </SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={"msg"}
                              required={true}
                              schemaName={"Message (string)"}
                              qualifierMessage={undefined}
                              schema={{ type: "string", title: "Message" }}
                            ></SchemaItem>
                            <SchemaItem
                              collapsible={false}
                              name={"type"}
                              required={true}
                              schemaName={"Error Type (string)"}
                              qualifierMessage={undefined}
                              schema={{ type: "string", title: "Error Type" }}
                            ></SchemaItem>
                            <li>
                              <div
                                style={{ fontSize: "var(--ifm-code-font-size)", opacity: "0.6", marginLeft: "-.5rem" }}
                              >
                                ]
                              </div>
                            </li>
                          </div>
                        </details>
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem>
                <TabItem label={"Example (from schema)"} value={"Example (from schema)"}>
                  <ResponseSamples
                    responseExample={
                      '{\n  "detail": [\n    {\n      "loc": [\n        "string",\n        0\n      ],\n      "msg": "string",\n      "type": "string"\n    }\n  ]\n}'
                    }
                    language={"json"}
                  ></ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>
