Skip to main content

getReservations

client.mail.getReservations(params?: Record<string, unknown>): Promise<MailReservation[]>

Lists all currently active resource reservations.

Returns all reservations that have not been released, providing visibility into which resources are currently claimed by which agents.

Parameters

ParameterTypeRequiredDescription
paramsRecord<string, unknown>NoOptional query parameters for filtering reservations

Returns

Promise<MailReservation[]> — A promise that resolves to an array of active reservations

Example

import { CodeBoltClient } from '@codebolt/clientsdk';

const client = new CodeBoltClient();

const result = await client.mail.getReservations();
console.log(result);