tasks/get

GET/scheduled-agents/{scheduled_agent_id}

Get one Task. Requires the configuration:read permission.

Request

cURL

curl -X GET "https://provisioning.cloudx.io/api/v1/scheduled-agents/{scheduled_agent_id}" \
  -H "Authorization: Bearer $CLOUDX_API_KEY"

Path parameters

Name	Type	Description
`scheduled_agent_id`required	`string`	Task ID.

Responses

Task.

{
  "id": "<string>",
  "domain": "buying",
  "name": "<string>",
  "prompt": "<string>",
  "template_id": "<string>",
  "cron_expression": "<string>",
  "timezone": "<string>",
  "schedule_description": "<string>",
  "enabled": true,
  "creation_origin": "web_app",
  "access_mode": "private",
  "creator_user_id": "<string>",
  "next_run_at": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>"
}

200Task.

Field	Type	Description
`id`required	`string`	Stable Task ID.
`domain`required	`string`	Side of the platform the Task works for.
`name`required	`string`
`prompt`required	`string`	Prompt that the Task runs on its schedule.
`template_id`	`string`	Template used to create the Task, when applicable.
`cron_expression`required	`string`	Five-field cron expression in the Task timezone.
`timezone`required	`string`	IANA timezone for the cron expression.
`schedule_description`required	`string`	Human-readable schedule.
`enabled`required	`boolean`
`creation_origin`required	`string`	Surface that created the Task.
`access_mode`required	`object`
`creator_user_id`	`string`	User who created the Task. Omitted for API and internal Tasks.
`next_run_at`required	`string<date-time>`
`created_at`required	`string<date-time>`
`updated_at`required	`string<date-time>`

401Unauthorized.

Field	Type	Description
`error`required	`string`

403Forbidden or feature unavailable.

Field	Type	Description
`error`required	`string`

404Task not found.

Field	Type	Description
`error`required	`string`

500Internal server error.

Field	Type	Description
`error`required	`string`