List UDFs - ClickHouse Documentation

GET

organizations

{organizationId}

udfs

List UDFs

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "items": [
      {
        "functionName": "<string>",
        "version": 1,
        "arguments": [
          {
            "name": "<string>",
            "type": "<string>"
          }
        ],
        "returnType": "<string>",
        "returnName": "<string>",
        "poolSize": 1,
        "commandReadTimeout": 123,
        "commandWriteTimeout": 123,
        "maxCommandExecutionTime": 1,
        "sendChunkHeader": true,
        "format": "<string>",
        "error": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "totalRecords": 123,
      "currentCursor": "<string>",
      "nextCursor": "<string>",
      "limit": 123
    }
  }
}

{
  "error": "<string>",
  "status": 400,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "status": 500,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Beta Disclaimer: This beta endpoint is evolving; the API contract may change.

Returns the latest version of each UDF in the organization.

Authorizations

Authorization

string

header

required

Use key ID and key secret obtained in ClickHouse Cloud console: https://clickhouse.com/docs/cloud/manage/openapi

Path Parameters

organizationId

string<uuid>

required

ID of the requested organization.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$

Query Parameters

cursor

string

Cursor returned in pagination.nextCursor from the previous page.

limit

integer

default:100

Maximum number of records to return per page. Defaults to 100. Maximum is 100.

Required range: x <= 100

Response

Successful response.

status

integer

required

HTTP status code.

Example:

200

requestId

string<uuid>

required

Unique id assigned to every request. UUIDv4

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$

result

object

required

Show child attributes

Last modified on August 3, 2026

List UDFs

curl --request GET \
  --url https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.clickhouse.cloud/v1/organizations/{organizationId}/udfs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body

{
  "status": 200,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "result": {
    "items": [
      {
        "functionName": "<string>",
        "version": 1,
        "arguments": [
          {
            "name": "<string>",
            "type": "<string>"
          }
        ],
        "returnType": "<string>",
        "returnName": "<string>",
        "poolSize": 1,
        "commandReadTimeout": 123,
        "commandWriteTimeout": 123,
        "maxCommandExecutionTime": 1,
        "sendChunkHeader": true,
        "format": "<string>",
        "error": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "totalRecords": 123,
      "currentCursor": "<string>",
      "nextCursor": "<string>",
      "limit": 123
    }
  }
}

{
  "error": "<string>",
  "status": 400,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "status": 500,
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}