List projects - Unkey Docs

POST

projects.listProjects

Python (SDK)

from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.projects.list_projects(limit=100, cursor="proj_1234abcd", search="billing-service")

    while res is not None:
        # Handle items

        res = res.next()

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.projects.listProjects({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v2"
	"github.com/unkeyed/sdks/api/go/v2/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Projects.ListProjects(ctx, components.V2ProjectsListProjectsRequestBody{})
    if err != nil {
        log.Fatal(err)
    }
    if res.V2ProjectsListProjectsResponseBody != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.unkey.com/v2/projects.listProjects', 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.unkey.com/v2/projects.listProjects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/projects.listProjects")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/projects.listProjects")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "data": [
    {
      "createdAt": 1704067200000,
      "deleteProtection": true,
      "id": "proj_1234abcd",
      "name": "Payments Service",
      "slug": "payments-service",
      "updatedAt": 1704153600000
    },
    {
      "createdAt": 1704240000000,
      "deleteProtection": false,
      "id": "proj_5678efgh",
      "name": "Billing Service",
      "slug": "billing-service"
    }
  ],
  "meta": {
    "requestId": "req_1234abcd"
  },
  "pagination": {
    "cursor": "proj_5678efgh",
    "hasMore": false
  }
}

{
  "error": {
    "detail": "The limit must be between 1 and 100.",
    "errors": [
      {
        "fix": "Use a limit between 1 and 100",
        "location": "body.limit",
        "message": "must be less than or equal to 100"
      }
    ],
    "status": 400,
    "title": "Bad Request",
    "type": "validation-error"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "error": {
    "detail": "Your root key requires the 'project.*.read_project' permission to perform this operation",
    "status": 403,
    "title": "Forbidden",
    "type": "forbidden"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

Authorizations

Authorization

string

header

required

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs. To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key. Security best practices:

Keep root keys secure and never expose them in client-side code
Use different root keys for different environments
Rotate keys periodically, especially after team member departures
Create keys with minimal necessary permissions following least privilege principle
Monitor key usage with audit logs.

Body

application/json

limit

integer

default:100

Maximum number of projects to return per request. Balance between response size and number of pagination calls needed.

Required range: 1 <= x <= 100

cursor

string

Pagination cursor from a previous response to fetch the next page. Use when hasMore: true in the previous response.

Example:

"proj_1234abcd"

string

Free-form text to filter projects. Returns projects whose ID, name, or slug contains the search string. Matching is case-insensitive.

Maximum string length: 256

Example:

"billing-service"

Response

Successfully retrieved a paginated list of projects. Use the pagination cursor for additional results when hasMore: true.

meta

object

required

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

data

object[]

required

Array of projects in the workspace, ordered by project id.

Maximum array length: 100

Show child attributes

pagination

object

required

Pagination metadata for list endpoints. Provides information necessary to traverse through large result sets efficiently using cursor-based pagination.

Show child attributes

Last modified on July 23, 2026

Update projectUpdate an existing project in your workspace, identified by its id. The project name, slug, and delete protection setting can be changed. Omitted fields are left unchanged. Changing the slug affects the deployment domains generated for this project. **Required Permissions** Your root key must have one of the following permissions: - `project.*.update_project` (to update any project) - `project.<project_id>.update_project` (to update a specific project)

⌘I

Python (SDK)

from unkey.py import Unkey


with Unkey(
    root_key="<YOUR_BEARER_TOKEN_HERE>",
) as unkey:

    res = unkey.projects.list_projects(limit=100, cursor="proj_1234abcd", search="billing-service")

    while res is not None:
        # Handle items

        res = res.next()

import { Unkey } from "@unkey/api";

const unkey = new Unkey({
  rootKey: process.env["UNKEY_ROOT_KEY"] ?? "",
});

async function run() {
  const result = await unkey.projects.listProjects({});

  for await (const page of result) {
    console.log(page);
  }
}

run();

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v2"
	"github.com/unkeyed/sdks/api/go/v2/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Projects.ListProjects(ctx, components.V2ProjectsListProjectsRequestBody{})
    if err != nil {
        log.Fatal(err)
    }
    if res.V2ProjectsListProjectsResponseBody != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.unkey.com/v2/projects.listProjects', 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.unkey.com/v2/projects.listProjects",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

HttpResponse<String> response = Unirest.post("https://api.unkey.com/v2/projects.listProjects")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/projects.listProjects")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

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

{
  "data": [
    {
      "createdAt": 1704067200000,
      "deleteProtection": true,
      "id": "proj_1234abcd",
      "name": "Payments Service",
      "slug": "payments-service",
      "updatedAt": 1704153600000
    },
    {
      "createdAt": 1704240000000,
      "deleteProtection": false,
      "id": "proj_5678efgh",
      "name": "Billing Service",
      "slug": "billing-service"
    }
  ],
  "meta": {
    "requestId": "req_1234abcd"
  },
  "pagination": {
    "cursor": "proj_5678efgh",
    "hasMore": false
  }
}

{
  "error": {
    "detail": "The limit must be between 1 and 100.",
    "errors": [
      {
        "fix": "Use a limit between 1 and 100",
        "location": "body.limit",
        "message": "must be less than or equal to 100"
      }
    ],
    "status": 400,
    "title": "Bad Request",
    "type": "validation-error"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "error": {
    "detail": "Your root key requires the 'project.*.read_project' permission to perform this operation",
    "status": 403,
    "title": "Forbidden",
    "type": "forbidden"
  },
  "meta": {
    "requestId": "req_1234abcd"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}

{
  "meta": {
    "requestId": "req_123"
  },
  "error": {
    "detail": "Property foo is required but is missing.",
    "status": 404,
    "title": "Not Found",
    "type": "https://unkey.com/docs/errors/unkey/resource/not_found"
  }
}