Skip to main content
GET
/
headless
/
imports
/
{id}
/
Retrieve headless import
curl --request GET \
  --url https://app.dromo.io/api/v1/headless/imports/{id}/ \
  --header 'X-Dromo-License-Key: <api-key>'
import requests

url = "https://app.dromo.io/api/v1/headless/imports/{id}/"

headers = {"X-Dromo-License-Key": "<api-key>"}

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

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

fetch('https://app.dromo.io/api/v1/headless/imports/{id}/', 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://app.dromo.io/api/v1/headless/imports/{id}/",
  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-Dromo-License-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://app.dromo.io/api/v1/headless/imports/{id}/"

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

	req.Header.Add("X-Dromo-License-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://app.dromo.io/api/v1/headless/imports/{id}/")
  .header("X-Dromo-License-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.dromo.io/api/v1/headless/imports/{id}/")

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

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

response = http.request(request)
puts response.read_body
{
  "id": "94187d21-9820-420f-b08c-a80cbbf52604",
  "schema_id": "94187d21-9820-420f-b08c-a80cbbf52604",
  "status": "AWAITING_UPLOAD",
  "original_filename": "user_data.csv",
  "created_date": "2023-11-07T05:31:56Z",
  "modified_date": "2023-11-07T05:31:56Z",
  "upload": "https://dromo-headless-imports-prod.s3.us-west-2.amazonaws.com/test-key-123?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20230227%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230227T160315Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=example1234567890abcdef1234567890abcdef1234567890abcdef12345678",
  "review_url": "https://app.dromo.io/headless/94187d21-9820-420f-b08c-a80cbbf52604/",
  "result_metadata": null,
  "import_errors": null
}

Authorizations

​
X-Dromo-License-Key
string
header
required

This backend API key is different than your frontend license key. Please use the "Backend" license key from your Dromo Dashboard.

Path Parameters

​
id
string<uuid>
required

Headless import ID

Example:

"66d6300d-1414-4655-83b4-8c80fc527315"

Response

Return headless import

​
id
string
read-only
Example:

"94187d21-9820-420f-b08c-a80cbbf52604"

​
schema_id
string
Example:

"94187d21-9820-420f-b08c-a80cbbf52604"

​
status
enum<string>
read-only
Available options:
AWAITING_UPLOAD,
RUNNING,
SUCCESSFUL,
FAILED,
NEEDS_REVIEW
Example:

"AWAITING_UPLOAD"

​
original_filename
string
Example:

"user_data.csv"

​
created_date
string<date-time>
read-only
​
modified_date
string<date-time>
read-only
​
upload
string
read-only
Example:

"https://dromo-headless-imports-prod.s3.us-west-2.amazonaws.com/test-key-123?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20230227%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20230227T160315Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=example1234567890abcdef1234567890abcdef1234567890abcdef12345678"

​
review_url
string
read-only
Example:

"https://app.dromo.io/headless/94187d21-9820-420f-b08c-a80cbbf52604/"

​
result_metadata
object | null
Example:

null

​
import_errors
object[] | null
Example:

null