Skip to main content
GET/functions

List Functions

Returns the cursor-paginated function registry for the specified project.

Supports filters on source, tier, and status.

Each entry includes name, runtime, tier, status, version, source, description, created_at, deployed_at, and error_detail.

Requires PROJECT_ADMIN minimum.

Parameters
modulequery

Return only the operations of this module, named <module>:<operation>.

sourcequery

Return only functions with this source: developer for ones you deployed, extension:<slug> for ones an installed extension owns.

tierquery

Return only functions that run on this tier.

statusquery

Return only functions in this state.

Omit it for every state, retired included.

cursorquery

meta.cursor.next from the previous page.

Omit it for the first page.

limitquery

How many functions to return, 1 to 100.

Default 50.

projectSlug *path

The project's slug: the path segment after @.

It is unique within the org.

Responses
HTTPK9O CodeDescription
200Success
400K9O_INVALID_FILTERThe filter expression supplied is malformed or references an invalid field.
401K9O_INVALID_CREDENTIALSThe request credentials are missing or invalid.
401K9O_SESSION_EXPIREDYour session has expired; sign in again to continue.
403K9O_ACCESS_DENIEDYour role does not grant access to list functions for this project.
Response body (200)
data *object[]

The project's functions, newest first, retired ones included unless status filters them out.

When more match, meta.cursor.next holds the cursor for the next page; otherwise it is null.

id *string <uuid>

The function's id, a UUID.

It stays the same across redeploys.

name *string

The function's name.

A module's operations are named <module>:<operation>.

runtime *"bun" | "rust" | "go" | "tinygo" | "zig" | "assemblyscript" | "c" | "cpp"

The language runtime: bun, rust, go, tinygo, zig, assemblyscript, c or cpp.

tier *"gateway" | "sandbox"

Where the function runs: gateway or sandbox.

entryPoint *string

The artifact key of the deployed code.

version *string

The version label of the deploy.

status *"deploying" | "active" | "error" | "retired"

deploying while the code is prepared, active once it can be invoked, error when preparing it failed (see errorDetail), retired after it was deleted.

source *string

Who manages the function: developer for one you deployed, extension:<slug> for one an installed extension owns.

description *any

What the function does.

Null when none was given.

One of: string
or: null
createdAt *string <date-time>

When the function was first deployed.

deployedAt *any

When the current deploy became active.

Null while it is deploying.

One of: string <date-time>
or: null
retiredAt *any

When the function was retired.

Null unless status is retired.

One of: string <date-time>
or: null
errorDetail *any

Why the deploy failed.

Null unless status is error.

One of: string
or: null
meta *any
TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.functions.list()

Showing example in TypeScript

Response example (200)
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "runtime": "bun",
      "tier": "gateway",
      "entryPoint": "string",
      "version": "string",
      "status": "deploying",
      "source": "string",
      "description": "string",
      "createdAt": "string",
      "deployedAt": "string",
      "retiredAt": "string",
      "errorDetail": "string"
    }
  ]
}

More in Compute & Automation