List Schedule Jobs

List all scheduled jobs

GET /schedules/v1/cron-jobs

cURL

cURL

curl --request GET \
  --url https://api.cekura.ai/schedules/v1/cron-jobs/ \
  --header 'X-CEKURA-API-KEY: <api-key>'

200

[
  {
    "id": 123,
    "agent": 123,
    "name": "<string>",
    "crontab_expression": "<string>",
    "timezone": "<string>",
    "scenario_ids": [
      123
    ],
    "scenarios_data": [
      {
        "id": 123,
        "agent": 123,
        "name": "<string>",
        "personality": 123,
        "personality_name": "<string>"
      }
    ],
    "personality": 123,
    "personalities": [
      123
    ],
    "tags": [
      "<string>"
    ],
    "frequency": 50,
    "run_as_text": true,
    "execution_mode": "voice",
    "notify_on": "never",
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

X-CEKURA-API-KEY · string · header · required

API Key Authentication. It should be included in the header of each request.

Query Parameters

agent_id · string

Filter by agent id Example: 123

project_id · string

Filter by project id Example: 123

Response

200 - application/json

id · integer

agent · integer

Agent ID for the cron job Example: 123

name · string

Name for the cronjob

Maximum string length: 255

crontab_expression · string

Crontab expression for the cron job Example:

• "0 9 * * 1-5"
• "0 0 * * 0"

Maximum string length: 255

timezone · string

Timezone for the cron job Example: "America/Los_Angeles"

scenario_ids · integer[]

List of scenario IDs for the cron job Example: [123, 456, 789]

scenarios_data · object[]

Show child attributes

personality · integer | null

(Deprecated) Use personalities field instead. Example: 1 (personality ID)

personalities · integer[]

List of personalities to use for test execution. Multiple personalities can be assigned to run tests with different configurations. Example: [1, 2, 3] (personality IDs)

tags · string[]

List of tags for the cron job Example: ["tag1", "tag2", "tag3"]

frequency · integer

Frequency for the cron job Example: 1

Required range: 1 <= x <= 100

run_as_text · boolean

DEPRECATED: Use execution_mode instead. Kept for backward compatibility. Run the cron job as text Example: true or false

execution_mode · enum<string>

Execution mode for the cron job Choices: voice, text, sip Example: "voice", "text", or "sip"

• voice - Voice
• text - Text
• sip - SIP

Available options: voice, text, sip

notify_on · enum<string>

Select when to notify

• never - Never
• success - Success
• failure - Failure
• both - Both

Available options: never, success, failure, both

is_active · boolean

created_at · string<date-time>

Timestamp when the cron job was created Example: 2021-01-01 00:00:00

updated_at · string<date-time>

Timestamp when the cron job was last updated Example: 2021-01-01 00:00:00