List Crons

import { cuey } from "cuey";

const { data: crons, pagination } = await cuey.crons.list();

import { cuey } from "cuey";

const { data: crons, pagination } = await cuey.crons.list({
  page: 1,
  limit: 50,
});

import { cuey } from "cuey";

const { data: activeCrons } = await cuey.crons.list({
  is_active: true,
});

{
  "data": [
    {
      "id": "cron-uuid-here",
      "cron_expression": "0 9 * * *",
      "timezone": "America/New_York",
      "webhook_url": "https://api.example.com/webhook",
      "method": "POST",
      "headers": null,
      "payload": {
        "report_type": "daily"
      },
      "retry_config": null,
      "is_active": true,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "team_id": "team-uuid-here"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 100,
    "total": 1
  }
}

Overview

List all cron jobs with optional pagination and filtering by active status.

import { cuey } from "cuey";

const { data: crons, pagination } = await cuey.crons.list();

import { cuey } from "cuey";

const { data: crons, pagination } = await cuey.crons.list({
  page: 1,
  limit: 50,
});

import { cuey } from "cuey";

const { data: activeCrons } = await cuey.crons.list({
  is_active: true,
});

Parameters

number

default:"0"

Page number (0-indexed). Defaults to 0.

number

default:"100"

Number of items per page. Range: 1-1000. Defaults to 100.

boolean

Filter cron jobs by active status. true for active crons, false for inactive crons.

Response

Cron[]

required

Array of cron job objects.

Show Cron properties

string

required

Unique identifier for the cron job (UUID).

string

required

Cron expression defining the schedule (e.g., 0 9 * * *).

string | null

Timezone for the cron schedule (e.g., America/New_York). null for UTC.

string

required

The webhook URL that will be called.

HttpMethod

required

HTTP method used for the webhook request. Defaults to POST.

object | null

Custom headers to include in the webhook request. null if not set.

object | null

Payload to send with the webhook request. null if not set.

object | null

Retry configuration for failed webhooks.

Show RetryConfig properties

number

required

Maximum number of retry attempts (1-10).

number

required

Backoff delay in milliseconds (100-5000).

string

required

Backoff strategy. Values: exponential, linear.

boolean | null

Whether the cron job is active. null defaults to true.

string | null

ISO 8601 timestamp when the cron job was created.

string | null

ISO 8601 timestamp when the cron job was last updated.

string | null

Team ID associated with the cron job.

object

required

Pagination information.

Show Pagination properties

number

required

Current page number (0-indexed).

number

required

Number of items per page.

number

required

Total number of items across all pages.

{
  "data": [
    {
      "id": "cron-uuid-here",
      "cron_expression": "0 9 * * *",
      "timezone": "America/New_York",
      "webhook_url": "https://api.example.com/webhook",
      "method": "POST",
      "headers": null,
      "payload": {
        "report_type": "daily"
      },
      "retry_config": null,
      "is_active": true,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "team_id": "team-uuid-here"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 100,
    "total": 1
  }
}

Errors

Requesting a page number that is out of range (e.g., page 100 when only 10 pages exist) will throw an InternalServerError.

UnauthorizedError: If API key is invalid or missing
InternalServerError: If the requested page is out of range

Examples

List Active Crons

import { cuey } from "cuey";

const { data: activeCrons } = await cuey.crons.list({
  is_active: true,
});

console.log(`Found ${activeCrons.length} active cron jobs`);

List Inactive Crons

import { cuey } from "cuey";

const { data: inactiveCrons } = await cuey.crons.list({
  is_active: false,
});

console.log(`Found ${inactiveCrons.length} inactive cron jobs`);

import { cuey } from "cuey";

const { data: crons, pagination } = await cuey.crons.list();

import { cuey } from "cuey";

const { data: crons, pagination } = await cuey.crons.list({
  page: 1,
  limit: 50,
});

import { cuey } from "cuey";

const { data: activeCrons } = await cuey.crons.list({
  is_active: true,
});

{
  "data": [
    {
      "id": "cron-uuid-here",
      "cron_expression": "0 9 * * *",
      "timezone": "America/New_York",
      "webhook_url": "https://api.example.com/webhook",
      "method": "POST",
      "headers": null,
      "payload": {
        "report_type": "daily"
      },
      "retry_config": null,
      "is_active": true,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "team_id": "team-uuid-here"
    }
  ],
  "pagination": {
    "page": 0,
    "limit": 100,
    "total": 1
  }
}

TypeScript SDK

Advanced

Overview

Parameters

Response

Errors

Examples

List Active Crons

List Inactive Crons

​Overview

​Parameters

​Response

​Errors

​Examples

​List Active Crons

​List Inactive Crons

Overview

Parameters

Response

Errors

Examples

List Active Crons

List Inactive Crons