List portal sessions

List the end users holding a revocable session on a portal, with each end user’s sessions.

Unreleased and subject to change without notice.

A session is revocable until it expires or is revoked. That includes sessions whose portal URL was created but not opened yet. Pass an end user’s externalId to portal.revokeSession to end their sessions.

Required Permissions

Your root key must have one of:

portal.*.create_portal_session (for any portal in the workspace)
portal.<portal_id>.create_portal_session (for a specific portal)

It also accepts unkey:v1:<workspace_id>:projects/<project_id>/portals/<portal_id>/sessions/* with #read or #write. Reading the portal itself is not enough.

Without the permission this returns 404, not 403.

POST

portal.listSessions

Go (SDK)

package main

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

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

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

    res, err := s.Portal.ListSessions(ctx, components.V2PortalListSessionsRequestBody{
        Portal: "proj_1234abcd",
        Cursor: unkey.Pointer("user_123"),
        Search: unkey.Pointer("user_"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2PortalListSessionsResponseBody != nil {
        // handle response
    }
}

from unkey.py import Unkey


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

    res = unkey.portal.list_sessions(portal="proj_1234abcd", limit=100, cursor="user_123", search="user_")

    # Handle response
    print(res)

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

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

async function run() {
  const result = await unkey.portal.listSessions({
    portal: "proj_1234abcd",
    cursor: "user_123",
    search: "user_",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.unkey.com/v2/portal.listSessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "portal": "proj_1234abcd",
  "limit": 100,
  "cursor": "user_123",
  "search": "user_"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({portal: 'proj_1234abcd', limit: 100, cursor: 'user_123', search: 'user_'})
};

fetch('https://api.unkey.com/v2/portal.listSessions', 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/portal.listSessions",
  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([
    'portal' => 'proj_1234abcd',
    'limit' => 100,
    'cursor' => 'user_123',
    'search' => 'user_'
  ]),
  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/portal.listSessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"portal\": \"proj_1234abcd\",\n  \"limit\": 100,\n  \"cursor\": \"user_123\",\n  \"search\": \"user_\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/portal.listSessions")

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 = "{\n  \"portal\": \"proj_1234abcd\",\n  \"limit\": 100,\n  \"cursor\": \"user_123\",\n  \"search\": \"user_\"\n}"

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

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "externalId": "user_123",
      "sessions": [
        {
          "id": "ps_1234abcd",
          "status": "active",
          "createdAt": 1704067200000,
          "expiresAt": 1704153600000,
          "scopes": [
            "keys:read"
          ]
        }
      ]
    }
  ],
  "pagination": {
    "hasMore": true,
    "cursor": "eyJrZXkiOiJrZXlfMTIzNCIsInRzIjoxNjk5Mzc4ODAwfQ=="
  }
}

{
  "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",
    "errors": [
      {
        "location": "body.permissions[0].name",
        "message": "Must be at least 3 characters long",
        "fix": "Ensure the name uses only alphanumeric characters, underscores, and hyphens"
      }
    ]
  }
}

{
  "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"
  }
}

{
  "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

portal

string

required

Identifies a resource by either its unique ID or its slug. Accepts a prefixed ID (such as 'proj_' or 'app_') or a slug.

Required string length: 3 - 255

Pattern: ^[a-zA-Z0-9_-]+$

Example:

"proj_1234abcd"

limit

integer

default:100

Maximum number of end users to return per request.

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:

"user_123"

string

Returns only end users whose externalId starts with this string. Matching is case-sensitive, and % and _ match literally.

Maximum string length: 256

Example:

"user_"

Response

One page of end users with revocable sessions.

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

End users with revocable sessions, ordered by externalId.

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

⌘I

Go (SDK)

package main

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

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

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

    res, err := s.Portal.ListSessions(ctx, components.V2PortalListSessionsRequestBody{
        Portal: "proj_1234abcd",
        Cursor: unkey.Pointer("user_123"),
        Search: unkey.Pointer("user_"),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2PortalListSessionsResponseBody != nil {
        // handle response
    }
}

from unkey.py import Unkey


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

    res = unkey.portal.list_sessions(portal="proj_1234abcd", limit=100, cursor="user_123", search="user_")

    # Handle response
    print(res)

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

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

async function run() {
  const result = await unkey.portal.listSessions({
    portal: "proj_1234abcd",
    cursor: "user_123",
    search: "user_",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.unkey.com/v2/portal.listSessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "portal": "proj_1234abcd",
  "limit": 100,
  "cursor": "user_123",
  "search": "user_"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({portal: 'proj_1234abcd', limit: 100, cursor: 'user_123', search: 'user_'})
};

fetch('https://api.unkey.com/v2/portal.listSessions', 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/portal.listSessions",
  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([
    'portal' => 'proj_1234abcd',
    'limit' => 100,
    'cursor' => 'user_123',
    'search' => 'user_'
  ]),
  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/portal.listSessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"portal\": \"proj_1234abcd\",\n  \"limit\": 100,\n  \"cursor\": \"user_123\",\n  \"search\": \"user_\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.unkey.com/v2/portal.listSessions")

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 = "{\n  \"portal\": \"proj_1234abcd\",\n  \"limit\": 100,\n  \"cursor\": \"user_123\",\n  \"search\": \"user_\"\n}"

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

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "externalId": "user_123",
      "sessions": [
        {
          "id": "ps_1234abcd",
          "status": "active",
          "createdAt": 1704067200000,
          "expiresAt": 1704153600000,
          "scopes": [
            "keys:read"
          ]
        }
      ]
    }
  ],
  "pagination": {
    "hasMore": true,
    "cursor": "eyJrZXkiOiJrZXlfMTIzNCIsInRzIjoxNjk5Mzc4ODAwfQ=="
  }
}

{
  "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",
    "errors": [
      {
        "location": "body.permissions[0].name",
        "message": "Must be at least 3 characters long",
        "fix": "Ensure the name uses only alphanumeric characters, underscores, and hyphens"
      }
    ]
  }
}

{
  "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"
  }
}

{
  "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"
  }
}

APIs

Keys

Identities

Permissions

Rate limiting

Analytics

Portal

List portal sessions

Authorizations

Body

Response