Files
zitadel/packages/zitadel-client
Max Peintner e4f633bcb3 chore: cleanup scripts, v1.3.1 @zitadel/client @zitadel/proto (#10329)
This PR includes scripts for cleaning up workspaces, and changes the
versions of @zitadel/client and /proto to v1.3.0
2025-07-28 13:32:41 +02:00
..

ZITADEL Client

This package exports services and utilities to interact with ZITADEL

Installation

To install the package, use npm or yarn:

npm install @zitadel/client

or

yarn add @zitadel/client

Usage

Importing Services

You can import and use the services provided by this package to interact with ZITADEL.

import { createSettingsServiceClient, makeReqCtx } from "@zitadel/client/v2";

// Example usage
const transport = createServerTransport(process.env.ZITADEL_SERVICE_USER_TOKEN!, { baseUrl: process.env.ZITADEL_API_URL! });

const settingsService = createSettingsServiceClient(transport);

settingsService.getBrandingSettings({ ctx: makeReqCtx("orgId") }, {});

Utilities

This package also provides various utilities to work with ZITADEL

import { timestampMs } from "@zitadel/client";

// Example usage
console.log(`${timestampMs(session.creationDate)}`);

Documentation

For detailed documentation and API references, please visit the ZITADEL documentation.

Contributing

Contributions are welcome! Please read the contributing guidelines before getting started.