List Functions

Retrieve all functions or function list with user information

GET /api/functions

List Functions

cURL

curl --request GET \
  --url https://api.example.com/api/functions/

200

{
  "functions": [
    {
      "id": "<string>",
      "user_id": "<string>",
      "type": "<string>",
      "name": "<string>",
      "content": "<string>",
      "meta": {},
      "is_active": true,
      "is_global": true,
      "user": {},
      "updated_at": 123,
      "created_at": 123
    }
  ]
}

Endpoints

Get Functions

GET

curl -X GET "https://your-instance.com/api/functions/" \
  -H "Authorization: Bearer YOUR_API_KEY"

Returns a list of all functions available in the system.

Response

functions · array

Array of function objects

Show FunctionResponse properties

id · string · required

Unique identifier for the function

user_id · string · required

ID of the user who created the function

type · string · required

Function type (e.g., “filter”, “action”)

name · string · required

Display name of the function

meta · object · required

Function metadata

Show meta properties

description · string

Function description

manifest · object

Function manifest data

is_active · boolean · required

Whether the function is currently active

is_global · boolean · required

Whether the function is globally available

updated_at · integer · required

Unix timestamp of last update

created_at · integer · required

Unix timestamp of creation

Get Function List (Admin)

GET /api/functions/list

curl -X GET "https://your-instance.com/api/functions/list" \
  -H "Authorization: Bearer YOUR_ADMIN_API_KEY"

Returns a detailed list of functions with user information. Requires admin privileges.

Response

functions · array

Array of function objects with user details

Show FunctionUserResponse properties

id · string · required

Function identifier

user_id · string · required

Creator user ID

type · string · required

Function type

name · string · required

Function name

content · string · required

Function source code

meta · object · required

Function metadata

is_active · boolean · required

Active status

is_global · boolean · required

Global availability

user · object

User information of the function creator

updated_at · integer · required

Last update timestamp

created_at · integer · required

Creation timestamp

Export Functions (Admin)

GET /api/functions/export

curl -X GET "https://your-instance.com/api/functions/export?include_valves=true" \
  -H "Authorization: Bearer YOUR_ADMIN_API_KEY"

Export all functions, optionally including valve configurations.

Query Parameters

include_valves · boolean · default: "false"

Include valve configurations in the export

Response

Returns an array of FunctionModel or FunctionWithValvesModel objects depending on the include_valves parameter.

Authentication

All endpoints require authentication via bearer token. The /list and /export endpoints require admin privileges.