authentik/website/docs/developer-docs/api/reference/enterprise-license-forecast-retrieve.api.mdx

---
id: enterprise-license-forecast-retrieve
title: "enterprise_license_forecast_retrieve"
description: "Forecast how many users will be required in a year"
sidebar_label: "enterprise_license_forecast_retrieve"
hide_title: true
hide_table_of_contents: true
api: eJytVV1P2zAU/SuWn6MaFR4mnoamgirBhATby4QqJ7k0pq4dbKesq/Lfd6+TEEOhTBNPseP7dc49vt5xW4OTQVkzL/kpBxPA1U55WGhVgMHvvXVQSB8WDoJTsAGe8RJ84VRNbuh03luwyj6xtTRb1nhwnj0prVkOzMFjoxyUTBkm2RakwxBBLj0//ZVk5HcZ91A0ToUtnuy4bEKFx2qFu7sWTx342mJN6Ljj06Mj+hQWA5hAS1nXWHQEIx48lbbjvqhgLWkVtjVgsTZ/gCLsYbgBp6RWf8AxBMx68GwAj/a1I6qC6rIrKttIvYhQk/h0sATH24zD749thgRQLv4lZGL+cfSWGOuoj0y/dDgU7FBd2Wvs2JiggqbUlx1tgyCwhPY10YTi5FNb9xP7VkZXNnPOur1eGWsW9wo0wqTzlCvpnNwSpADr9L9HqZtlpLCwJbx9IstSUVqpr9N87cjHWFpX2bt8HH8iHxdgUMwFO7uev0NICUEq/QaoQ2hTKfUBks73SQ/AxF9rCJWlMbOEeKNkqHAjxhEg+nsnBvkJTjPBbaLCcSQ0TpOHrJXYHAveJiPjhujp8CWD4xlJFUJNwaIV7nMcQ/0lUebeRssey+ieccrcIZgeTU8mXybTPb6v5Ao5YoNX1zXm1brWMOFZbKssYluxf8Q7r0Br+3VpnzNNlCX2e/hRtDKWeTW/xRAdbILgT4VYqlA1+aSwa5GEEOMq1zYXmMqIy/m32febWYRZWx9wOifBR+L3Bh57b9onMv3Pwd/1I+DIEbXGIgl4BLjrFfHiURhJGYcSLkl7FQIi690ulx5+ON229PuxAUcPCC43Eqd6Tk3FBwQdQJbYcxLSCtCEnxUF1BRuI3UTW//63pHCnmV7MaNmEM+JsHohZcOCog/TxWyT2FhmtLi1KzBYatYXEWiPifDW/AXQAqhk
sidebar_class_name: "get api-method"
info_path: docs/developer-docs/api/reference/authentik
custom_edit_url: null
hide_send_button: true
---

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 Heading from "@theme/Heading";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"enterprise_license_forecast_retrieve"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/enterprise/license/forecast/"}
>
  
</MethodEndpoint>



Forecast how many users will be required in a year

<div>
  <div>
    <ApiTabs
      label={undefined}
      id={undefined}
    >
      <TabItem
        label={"200"}
        value={"200"}
      >
        <div>
          
          
          
          
          
        </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={false}
                        name={"internal_users"}
                        required={true}
                        schemaName={"integer"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"external_users"}
                        required={true}
                        schemaName={"integer"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"forecasted_internal_users"}
                        required={true}
                        schemaName={"integer"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"forecasted_external_users"}
                        required={true}
                        schemaName={"integer"}
                        qualifierMessage={undefined}
                        schema={{"type":"integer"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"internal_users\": 0,\n  \"external_users\": 0,\n  \"forecasted_internal_users\": 0,\n  \"forecasted_external_users\": 0\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"400"}
        value={"400"}
      >
        <div>
          
          
          
          
          
        </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={false}
                        name={"non_field_errors"}
                        required={false}
                        schemaName={"string[]"}
                        qualifierMessage={undefined}
                        schema={{"type":"array","items":{"type":"string"}}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        name={"property name*"}
                        required={false}
                        schemaName={"any"}
                        qualifierMessage={undefined}
                        schema={{"type":"object","description":"Validation Error","properties":{"non_field_errors":{"type":"array","items":{"type":"string"}},"code":{"type":"string"}},"additionalProperties":{},"title":"ValidationError"}}
                        collapsible={false}
                        discriminator={false}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"non_field_errors\": [\n    \"string\"\n  ],\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem><TabItem
        label={"403"}
        value={"403"}
      >
        <div>
          
          
          
          
          
        </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={false}
                        name={"detail"}
                        required={true}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem><SchemaItem
                        collapsible={false}
                        name={"code"}
                        required={false}
                        schemaName={"string"}
                        qualifierMessage={undefined}
                        schema={{"type":"string"}}
                      >
                        
                      </SchemaItem>
                    </ul>
                  </details>
                </TabItem><TabItem
                  label={"Example (from schema)"}
                  value={"Example (from schema)"}
                >
                  <ResponseSamples
                    responseExample={"{\n  \"detail\": \"string\",\n  \"code\": \"string\"\n}"}
                    language={"json"}
                  >
                    
                  </ResponseSamples>
                </TabItem>
              </SchemaTabs>
            </TabItem>
          </MimeTabs>
        </div>
      </TabItem>
    </ApiTabs>
  </div>
</div>