Get scheduled task

Use when you need to load a single scheduled task (e.g. to show details in a UI or check its configuration).

GET /tasks/scheduled/{id}

Get scheduled task

cURL

curl --request GET \
  --url https://us.api.flexprice.io/v1/tasks/scheduled/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "connection_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "enabled": true,
  "environment_id": "<string>",
  "id": "<string>",
  "job_config": {
    "bucket": "<string>",
    "endpoint_url": "<string>",
    "export_metadata_fields": [
      {
        "field_key": "<string>",
        "column_name": "<string>"
      }
    ],
    "key_prefix": "<string>",
    "region": "<string>",
    "use_path_style": true
  },
  "status": "<string>",
  "tenant_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id · string · required

Scheduled Task ID

Response

200

application/json

OK

connection_id · string

created_at · string<date-time>

enabled · boolean

entity_type · enum<string>

Available options: events, invoice, credit_topups, credit_usage, usage_analytics

environment_id · string

id · string

interval · enum<string>

Available options: 15MIN, 30MIN, custom, hourly, daily

job_config · object

Show child attributes

status · string

tenant_id · string

updated_at · string<date-time>