GET
/
tasks
/
{id}
Get a task by ID
curl --request GET \
  --url https://api.cloud.flexprice.io/v1/tasks/{id} \
  --header 'x-api-key: <api-key>'
{
  "completed_at": "<string>",
  "created_at": "<string>",
  "created_by": "<string>",
  "entity_type": "EVENTS",
  "error_summary": "<string>",
  "failed_at": "<string>",
  "failed_records": 123,
  "file_name": "<string>",
  "file_type": "CSV",
  "file_url": "<string>",
  "id": "<string>",
  "metadata": {},
  "processed_records": 123,
  "started_at": "<string>",
  "status": "<string>",
  "successful_records": 123,
  "task_status": "PENDING",
  "task_type": "IMPORT",
  "tenant_id": "<string>",
  "total_records": 123,
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string
required

Task ID

Response

OK

completed_at
string
created_at
string
created_by
string
entity_type
enum<string>
Available options:
EVENTS,
PRICES,
CUSTOMERS
error_summary
string
failed_at
string
failed_records
integer
file_name
string
file_type
enum<string>
Available options:
CSV,
JSON
file_url
string
id
string
metadata
object
processed_records
integer
started_at
string
status
string
successful_records
integer
task_status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
task_type
enum<string>
Available options:
IMPORT,
EXPORT
tenant_id
string
total_records
integer
updated_at
string
updated_by
string