Lists agent schedules.

GET

https://api.awork.com/api/v1/agents/:agentId/schedules

GET

/api/v1/agents/:agentId/schedules

curl https://api.awork.com/api/v1/agents/agentId/schedules \
     -H "Authorization: Bearer <token>"

[
  {
    "name": "string",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdOn": "2024-01-15T09:30:00Z",
    "agentId": "123e4567-e89b-12d3-a456-426614174000",
    "ownerUserId": "123e4567-e89b-12d3-a456-426614174000",
    "prompt": "string",
    "cronRule": "string",
    "recurrenceInterval": 1,
    "timezone": "string",
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "taskId": "123e4567-e89b-12d3-a456-426614174000",
    "isEnabled": true,
    "needsAttention": true,
    "lastFailureReason": "string",
    "consecutiveFailureCount": 1,
    "lastAttemptOn": "2024-01-15T09:30:00Z",
    "lastSuccessfulRunOn": "2024-01-15T09:30:00Z"
  }
]

Lists the schedules configured for an agent after checking the caller’s read access.

Required Permissions

Any authenticated user.

Lists the schedules configured for an agent after checking the caller's read access. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

agentIdstringRequiredformat: "uuid"

The agent id.

Response

namestring or nullOptional

The schedule display name.

idstringOptionalformat: "uuid"

The schedule id.

createdOnstringOptionalformat: "date-time"

When the schedule was created.

agentIdstringOptionalformat: "uuid"

The agent id that is executed by this schedule.

ownerUserIdstringOptionalformat: "uuid"

The user id whose context is used to execute the scheduled run.

promptstring or nullOptional

Optional custom instructions. An omitted or null prompt means no custom instructions.

cronRulestring or nullOptional

The normalized cron rule used for recurring execution.

recurrenceIntervalintegerOptional

The number of matching cron occurrences between scheduled runs.

timezonestring or nullOptional

The timezone used to evaluate the cron rule.

projectIdstring or nullOptionalformat: "uuid"

The optional project context id.

taskIdstring or nullOptionalformat: "uuid"

The optional task context id.

isEnabledbooleanOptional

Whether this schedule is active.

needsAttentionbooleanOptional

Whether the schedule needs user attention.

lastFailureReasonstring or nullOptional

The latest rejection reason.

consecutiveFailureCountintegerOptional

The number of consecutive failed scheduled executions.

lastAttemptOnstring or nullOptionalformat: "date-time"

The latest occurrence time.

lastSuccessfulRunOnstring or nullOptionalformat: "date-time"

The latest accepted occurrence time.

Errors

401

Unauthorized Error

404

Not Found Error