Tasks

List tasks

Changed on

Use when listing or searching async tasks (e.g. admin queue view). Returns list with optional filtering.

get/tasks

Request

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

Query parameters

created_bystring
end_timestring
entity_type'EVENTS' | 'PRICES' | 'CUSTOMERS' | 'FEATURES'
expandstring
limitinteger
offsetinteger
order'asc' | 'desc'
scheduled_task_idstring
sortstring
start_timestring
status'published' | 'deleted' | 'archived'
task_status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED'
task_type'IMPORT' | 'EXPORT'

Response

OK

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

  • 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

    • breaking

      the response's property type changed from no type to object 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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status