List keys

GET

storage

kvs

{id}

keys

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.storage.kvs.keys.list()) {
  console.log(response);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.storage.kvs.keys.list(
    "id",
)
print(page.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	keys, err := client.Storage.Kvs.Keys.List(
		context.TODO(),
		"id",
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", keys.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var page = client.storage().kvs().keys().list("id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->storage->kvs->keys->list(
    'id',
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "record_type": "storage_kv_key",
  "data": [
    {
      "key": "user/123",
      "size_bytes": 21,
      "updated_at": "2026-06-18T14:48:17Z"
    }
  ],
  "meta": {
    "has_more": false,
    "cursor": "<string>"
  }
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string<uuid>

required

KV namespace ID

Query Parameters

prefix

string

Return only keys that start with this prefix.

limit

integer

default:1000

Maximum number of keys to return. Values above 1000 are treated as 1000.

Required range: 1 <= x <= 1000

cursor

string

Opaque pagination cursor from a previous response's meta.cursor.

Response

Keys retrieved successfully

record_type

string

Example:

"storage_kv_key"

data

object[]

Show child attributes

meta

object

Show child attributes

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const response of client.storage.kvs.keys.list()) {
  console.log(response);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.storage.kvs.keys.list(
    "id",
)
print(page.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	keys, err := client.Storage.Kvs.Keys.List(
		context.TODO(),
		"id",
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", keys.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        var page = client.storage().kvs().keys().list("id");
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->storage->kvs->keys->list(
    'id',
  );

  var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}

{
  "record_type": "storage_kv_key",
  "data": [
    {
      "key": "user/123",
      "size_bytes": 21,
      "updated_at": "2026-06-18T14:48:17Z"
    }
  ],
  "meta": {
    "has_more": false,
    "cursor": "<string>"
  }
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "detail": "The requested function does not exist or you don't have access to it",
      "meta": {
        "url": "https://docs.telnyx.com/api/errors/10005"
      },
      "source": {
        "parameter": "id",
        "pointer": "/id"
      },
      "title": "Function not found"
    }
  ]
}

Get Started

Concepts

Examples

Reference

Platform

For AI Agents

Authorizations

Path Parameters

Query Parameters

Response