Skip to main content
GET
/
tasks
List tasks
curl --request GET \
  --url https://us.api.flexprice.io/v1/tasks \
  --header 'x-api-key: <api-key>'
import requests

url = "https://us.api.flexprice.io/v1/tasks"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://us.api.flexprice.io/v1/tasks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://us.api.flexprice.io/v1/tasks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://us.api.flexprice.io/v1/tasks"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://us.api.flexprice.io/v1/tasks")
.header("x-api-key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/tasks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "items": [
    {
      "completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "environment_id": "<string>",
      "error_summary": "<string>",
      "failed_at": "2023-11-07T05:31:56Z",
      "failed_records": 123,
      "file_name": "<string>",
      "file_url": "<string>",
      "id": "<string>",
      "metadata": {},
      "processed_records": 123,
      "scheduled_task_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "successful_records": 123,
      "tenant_id": "<string>",
      "total_records": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>",
      "workflow_id": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}
{
"http_status_code": 123,
"message": "<string>"
}
{
"http_status_code": 123,
"message": "<string>"
}

Authorizations

x-api-key
string
header
required

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

Query Parameters

created_by
string
end_time
string
entity_type
enum<string>
Available options:
EVENTS,
PRICES,
CUSTOMERS,
FEATURES
expand
string
limit
integer
Required range: 1 <= x <= 1000
offset
integer
Required range: x >= 0
order
enum<string>
Available options:
asc,
desc
scheduled_task_id
string
sort
string
start_time
string
status
enum<string>
Available options:
published,
deleted,
archived
task_status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
task_type
enum<string>
Available options:
IMPORT,
EXPORT

Response

OK

items
object[]
pagination
object