list_jobs
Retrieve agent jobs with filters like status, scheduled time, job type, channel code, and pagination for efficient job management and tracking.
Instructions
Retrieves a list of agent jobs, with optional filters and pagination.
Input Schema
Name | Required | Description | Default |
---|---|---|---|
channel_code | No | Filter by the channel code (e.g., 'C123456' for a Slack channel). | |
created_at_gte | No | Filter for jobs created at or after a specific time (ISO 8601). | |
created_at_lte | No | Filter for jobs created at or before a specific time (ISO 8601). | |
job_type_id | No | Filter by the specific job type ID (e.g., 'daily-report'). | |
limit | No | Maximum number of jobs to return (e.g.,20). Default is 20. | |
offset | No | Number of jobs to skip, used for pagination. Default is 0. | |
org_id | No | Filter by organization ID. If not provided, the default from the environment is used. | |
scheduled_at | No | Filter by the exact scheduled time in ISO 8601 format (e.g., '2024-07-23T10:00:00Z'). | |
scheduled_at_gte | No | Filter for jobs scheduled at or after a specific time (ISO 8601). | |
scheduled_at_lte | No | Filter for jobs scheduled at or before a specific time (ISO 8601). | |
sort | No | Field to sort by and direction. Format is 'field:direction'. Example: 'created_at:desc'. | |
status | No | Filter by job status. Possible values are: 'waiting', 'scheduled', 'running', 'completed', 'failed', 'canceled'. |