Tasks

Get a task

Changed on

Use when checking task status or progress (e.g. polling after create). Returns task by ID.

get/tasks/{id}

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/tasks/{id}
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Task ID

Response

OK

completed_atstring date-time
created_atstring date-time
created_bystring
entity_type'EVENTS' | 'PRICES' | 'CUSTOMERS' | 'FEATURES'
environment_idstring
error_summarystring
failed_atstring date-time
failed_recordsinteger
file_namestring
file_type'CSV' | 'JSON'
file_urlstring
idstring
metadataobject
processed_recordsinteger
scheduled_task_idstring
started_atstring date-time
status'published' | 'deleted' | 'archived'
successful_recordsinteger
task_status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED'
task_type'IMPORT' | 'EXPORT'
tenant_idstring
total_recordsinteger
updated_atstring date-time
updated_bystring
workflow_idstring

Changes

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

  • 7d57386313c7Revision changes
    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • warning

      added the new COMPLETED enum value to the response property for the response status

    • warning

      added the new CSV enum value to the response property for the response status

    • warning

      added the new EXPORT enum value to the response property for the response status

    • warning

      added the new FAILED enum value to the response property for the response status

    • warning

      added the new IMPORT enum value to the response property for the response status

    • warning

      added the new JSON enum value to the response property for the response status

    • warning

      added the new PENDING enum value to the response property for the response status

    • warning

      added the new PROCESSING enum value to the response property for the response status

    • warning

      added the new archived enum value to the response property for the response status

    • warning

      added the new deleted enum value to the response property for the response status

    • warning

      added the new published enum value to the response property for the response status