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

# Get User Defined Functions

> A user-defined function (UDF) is a function that you can define yourself and use in your queries. It is a way to extend the functionality of the database.




## OpenAPI

````yaml https://dev.enneo.dev/api/mind/docs/open-api get /settings/user-defined-function
openapi: 3.0.0
info:
  version: '1'
  title: enneo.MIND API
  description: This describes the API of enneo Mind, the main ticketing backend
  contact:
    name: enneo GmbH
    email: richard@enneo.ai
  license:
    name: Proprietary software
    url: https://enneo.ai
servers:
  - url: https://demo.enneo.ai/api/mind
    description: Production server, demo client
  - url: https://main.enneo.dev/api/mind
    description: Development main branch
  - url: http://localhost:8005/api/mind
    description: Local development server
security:
  - bearerAuth:
      - api
  - cookieAuth:
      - api
paths:
  /settings/user-defined-function:
    get:
      tags:
        - Settings
      summary: Get User Defined Functions
      description: >
        A user-defined function (UDF) is a function that you can define yourself
        and use in your queries. It is a way to extend the functionality of the
        database.
      operationId: getUserDefinedFunctions
      parameters:
        - name: filter
          in: query
          required: false
          description: >-
            Filter by type of user defined function. If 'tool', only tool
            functions are returned. If 'udf', only non-tool functions are
            returned.
          schema:
            type: string
            enum:
              - tool
              - udf
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Success'
                  - type: object
                    properties:
                      userDefinedFunctions:
                        type: array
                        items:
                          $ref: '#/components/schemas/UserDefinedFunction'
        '403':
          description: Unauthorized
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Success:
      type: object
      description: Data format of Enneo success messages
      properties:
        success:
          type: boolean
          example: true
          description: Operation was successful
    UserDefinedFunction:
      type: object
      properties:
        id:
          type: integer
          example: 1
        type:
          type: string
          enum:
            - tool
            - udf
        data:
          type: object
          properties:
            udfExecutor:
              type: object
              properties:
                id:
                  type: integer
                  example: 1
                code:
                  type: string
                  example: >-
                    <?php


                    // Load enneo SDK. Input is made available through $in

                    use EnneoSDK\Api;

                    use EnneoSDK\ApiEnneo;

                    require(getenv()['SDK']);


                    function exampleApiCall(string $method, string $api,
                    array|object|string|false $params = false, $attempt = 1):
                    stdClass|array

                    {
                        // load token
                        $token = ApiEnneo::executeUdf('fetchToken', [])->token;

                        // make request
                        $res = Api::call(
                            method: $method,
                            url: sprintf('urlExampleHere', $api),
                            headers: [
                                sprintf('Authorization: Bearer %s', $token),
                                'x-api-key: tokenExampleHere',
                                'Accept: application/json'
                            ],
                            params: $params
                        );

                        return $res;
                    }


                    echo json_encode(exampleApiCall($in->method, $in->api,
                    $in->params));
                type:
                  type: string
                  example: sourceCode
                language:
                  type: string
                  example: php82
                packages:
                  type: string
                  example: ''
                parameters:
                  type: array
                  items:
                    type: object
                    description: Parameter definitions for the executor
                  example: []
        name:
          type: string
          example: exampleApiCall
    Error:
      type: object
      description: Data format of Enneo error messages
      properties:
        error:
          type: string
          example: Contract 121 could not be processed
          description: Readable error message that should be shown to the user
        details:
          type: string
          example: >-
            Uncatched null point exception in testFunction() in
            /app/src/file:212
          description: Not easily readable error message that is for the developer
        txId:
          type: string
          example: c916167c94
          description: >-
            Internal transaction id. Useful for debugging. Corresponds to the
            OpenTelemetry trace ID.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT-based authentication
      x-scopes:
        api: Full access to the API
    cookieAuth:
      type: apiKey
      in: cookie
      name: connect.sid
      description: Cookie-based authentication
      x-scopes:
        api: Full access to the API

````