> ## Documentation Index
> Fetch the complete documentation index at: https://docs.enginy.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get contact AI variable folder

> Get a contact AI variable folder with its child folders, AI variables, and breadcrumb ancestors.

    > **Required scope:** `AI_VARIABLES_READ`
    >
    > **Rate limit:** 100 requests per minute



## OpenAPI

````yaml https://openapi.enginy.ai/definitions.json get /v1/ai-variables/folders/contacts/{folderId}
openapi: 3.1.0
info:
  title: Enginy API
  version: 1.0.0
  description: Public API for Enginy platform
servers:
  - url: https://openapi.enginy.ai
    description: Configured server
security: []
tags:
  - name: AI Variables
    description: >-
      Manage AI variables and discover the entity fields you can reference in
      prompts and entity requests.
  - name: Inbox
    description: >-
      Inbox endpoints for listing contact threads, reading thread messages,
      managing tags, and sending manual replies.
  - name: Workflows
    description: >-
      Build, validate, publish, run, and inspect advanced (graph) workflows,
      plus the block/condition catalog needed to author a workflow plan.
paths:
  /v1/ai-variables/folders/contacts/{folderId}:
    get:
      tags:
        - AI Variables
      summary: Get contact AI variable folder
      description: >-
        Get a contact AI variable folder with its child folders, AI variables,
        and breadcrumb ancestors.

            > **Required scope:** `AI_VARIABLES_READ`
            >
            > **Rate limit:** 100 requests per minute
      parameters:
        - schema:
            type: string
            description: AI variable folder ID
          required: true
          description: AI variable folder ID
          name: folderId
          in: path
      responses:
        '200':
          description: Folder retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - success
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      id:
                        type: number
                      name:
                        type: string
                      parentId:
                        type:
                          - number
                          - 'null'
                      entity:
                        type: string
                        enum:
                          - CONTACT
                          - COMPANY
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                      aiVariablesCount:
                        type: number
                      subfoldersCount:
                        type: number
                      totalSubfoldersCount:
                        type: number
                      totalAiVariablesCount:
                        type: number
                      children:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                            name:
                              type: string
                            parentId:
                              type:
                                - number
                                - 'null'
                            createdAt:
                              type: string
                              format: date-time
                            updatedAt:
                              type: string
                              format: date-time
                            entity:
                              type: string
                              enum:
                                - CONTACT
                                - COMPANY
                            aiVariablesCount:
                              type: number
                            subfoldersCount:
                              type: number
                          required:
                            - id
                            - name
                            - parentId
                            - createdAt
                            - updatedAt
                            - entity
                            - aiVariablesCount
                            - subfoldersCount
                      parent:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: number
                          name:
                            type: string
                        required:
                          - id
                          - name
                      aiVariables:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                              description: Unique identifier for the AI variable.
                            name:
                              type: string
                              description: >-
                                Unique AI variable name. Use this exact name in
                                prompts and entity field requests.
                            prompt:
                              type: string
                              description: >-
                                Plain-text prompt template. Field references use
                                the `{fieldName}` syntax.
                            model:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Model ID used to run the variable. If omitted on
                                create, Enginy uses the default AI model.
                            outputSchema:
                              type: object
                              properties:
                                type:
                                  type: string
                                  enum:
                                    - text
                                    - number
                                    - date
                                    - oneOf
                                    - url
                                    - email
                                  description: >-
                                    Controls the output format Enginy expects
                                    from the AI variable.
                                values:
                                  type: array
                                  items:
                                    type: string
                                  description: >-
                                    Required when `type` is `oneOf`. Lists the
                                    allowed values the model should return.
                                provideExplanation:
                                  type: boolean
                                  description: >-
                                    When true, Enginy also stores an explanation
                                    alongside the generated value.
                                jsonSchema:
                                  anyOf:
                                    - type: string
                                    - type: number
                                    - type: boolean
                                    - type: 'null'
                                    - type: array
                                      items:
                                        anyOf:
                                          - type: string
                                          - type: number
                                          - type: boolean
                                          - type: 'null'
                                          - type: array
                                            items:
                                              anyOf:
                                                - type: string
                                                - type: number
                                                - type: boolean
                                                - type: 'null'
                                          - type: object
                                            additionalProperties:
                                              anyOf:
                                                - type: string
                                                - type: number
                                                - type: boolean
                                                - type: 'null'
                                    - type: object
                                      additionalProperties:
                                        anyOf:
                                          - type: string
                                          - type: number
                                          - type: boolean
                                          - type: 'null'
                                          - type: array
                                            items:
                                              anyOf:
                                                - type: string
                                                - type: number
                                                - type: boolean
                                                - type: 'null'
                                          - type: object
                                            additionalProperties:
                                              anyOf:
                                                - type: string
                                                - type: number
                                                - type: boolean
                                                - type: 'null'
                                  description: >-
                                    Advanced JSON schema override used by some
                                    structured-output AI variables.
                              required:
                                - type
                              additionalProperties: false
                              description: Output contract for the AI variable.
                            search:
                              type: boolean
                              description: >-
                                Enable or disable Deep Search for this AI
                                variable. This is the only public search option.
                            entity:
                              type: string
                              enum:
                                - CONTACT
                                - COMPANY
                              description: Which entity stores the resulting value.
                            folderId:
                              type:
                                - number
                                - 'null'
                              description: Folder ID used to organize the AI variable.
                            customWebsiteField:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Optional custom website source field used by
                                variables that crawl a specific website field.
                            description:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Auto-generated variable description, when
                                available.
                            isPublic:
                              type: boolean
                              description: >-
                                Whether the AI variable is globally public
                                inside Enginy.
                            archivedAt:
                              type:
                                - string
                                - 'null'
                              format: date-time
                              description: >-
                                Archive timestamp. Archived variables are
                                excluded from list results unless requested.
                            createdAt:
                              type: string
                              format: date-time
                              description: Creation timestamp.
                            updatedAt:
                              type: string
                              format: date-time
                              description: Last update timestamp.
                          required:
                            - id
                            - name
                            - prompt
                            - model
                            - outputSchema
                            - search
                            - entity
                            - folderId
                            - customWebsiteField
                            - description
                            - isPublic
                            - archivedAt
                            - createdAt
                            - updatedAt
                      ancestors:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: number
                            name:
                              type: string
                            parentId:
                              type:
                                - number
                                - 'null'
                          required:
                            - id
                            - name
                            - parentId
                    required:
                      - id
                      - name
                      - parentId
                      - entity
                      - createdAt
                      - updatedAt
                      - aiVariablesCount
                      - subfoldersCount
                      - children
                      - parent
                      - aiVariables
                      - ancestors
                required:
                  - status
                  - message
                  - data
        '404':
          description: Folder not found
      security:
        - apiKey: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````