Loading...
 
Skip to main content

Api Tabulars Doc

Get All Tracker Import-Export Formats


Get All Tracker Import-Export Formats

No Tabs


Request URL - tabulars
Copy to clipboard
https://example.com/api/tabulars


cURL - tabulars
Copy to clipboard
curl --request GET \
     --url "https://example.com/api/tabulars" \
     --header "accept: application/json" \
     --header "Authorization: Bearer <API_TOKEN>"


PHP - tabulars
Copy to clipboard
<?php

$url = 'https://example.com/api/tabulars';

$headers = [
    'Accept: application/json',
    'Authorization: Bearer <API_TOKEN>'
];

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($http_code === 200) {
    $data = json_decode($response, true);
    print_r($data);
} else {
    echo 'Error: HTTP status code ' . $http_code;
}

curl_close($ch);

?>


Javascript - tabulars
Copy to clipboard
fetch('https://example.com/api/tabulars', {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Authorization': 'Bearer <API_TOKEN>'
  }
})
.then(res => {
  if (!res.ok) throw new Error("HTTP " + res.status);
  return res.json();
})
.then(data => {
  console.log(data);
})
.catch(err => {
  console.log('Fetch error: ' + err.message);
});


Response - tabulars
Copy to clipboard
{
  "title": "Import-Export Formats",
  "formatList": [
    {
      "tabularId": 1,
      "name": "orders",
      "trackerId": 3
    },
    {
      "tabularId": 2,
      "name": "Contacts",
      "trackerId": 4
    },
    {
      "tabularId": 3,
      "name": "Deals",
      "trackerId": 6
    }
  ]
}



Parameters


No parameters.

Retrieve Tracker Import-Export Information


Retrieves detailed configuration information for a specific tracker import-export format.

No Tabs


Request URL - tabulars
Copy to clipboard
https://example.com/api/tabulars/{tabularId}


cURL - tabulars
Copy to clipboard
curl --request GET \
     --url "https://example.com/api/tabulars/2" \
     --header "accept: application/json" \
     --header "Authorization: Bearer <API_TOKEN>"


PHP - tabulars
Copy to clipboard
<?php

$tabularId = 2;
$url = "https://example.com/api/tabulars/{$tabularId}";

$headers = [
    'Accept: application/json',
    'Authorization: Bearer <API_TOKEN>'
];

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($http_code === 200) {
    $data = json_decode($response, true);
    print_r($data);
} else {
    echo 'Error: HTTP status code ' . $http_code;
}

curl_close($ch);

?>


Javascript - tabulars
Copy to clipboard
const tabularId = 2;

fetch('https://example.com/api/tabulars/' + tabularId, {
  method: 'GET',
  headers: {
    'Accept': 'application/json',
    'Authorization': 'Bearer <API_TOKEN>'
  }
})
.then(res => {
  if (!res.ok) throw new Error("HTTP " + res.status);
  return res.json();
})
.then(data => {
  console.log(data);
})
.catch(err => {
  console.log('Fetch error: ' + err.message);
});


Response - tabulars
Copy to clipboard
{
  "title": "Edit Format: Contacts",
  "tabularId": 2,
  "trackerId": 4,
  "name": "Contacts",
  "config": {
    "simple_headers": 1,
    "import_update": 1,
    "ignore_blanks": 0,
    "import_transaction": 0,
    "bulk_import": 0,
    "skip_unmodified": 0,
    "encoding": "",
    "format": "",
    "mapping": ""
  },
  "odbc_config": [],
  "api_config": [],
  "columns": [
    {
      "label": "ContactID",
      "field": "contactContactID",
      "mode": "default",
      "displayAlign": "left",
      "isPrimary": false,
      "isReadOnly": false,
      "isExportOnly": false,
      "isUniqueKey": false
    },
    {
      "label": "FirstName",
      "field": "contactFirstName",
      "mode": "default",
      "displayAlign": "left",
      "isPrimary": false,
      "isReadOnly": false,
      "isExportOnly": false,
      "isUniqueKey": false
    },
    {
      "label": "LastName",
      "field": "contactLastName",
      "mode": "default",
      "displayAlign": "left",
      "isPrimary": false,
      "isReadOnly": false,
      "isExportOnly": false,
      "isUniqueKey": false
    },
    {
      "label": "Email",
      "field": "contactEmail",
      "mode": "default",
      "displayAlign": "left",
      "isPrimary": false,
      "isReadOnly": false,
      "isExportOnly": false,
      "isUniqueKey": false
    },
    {
      "label": "Phone",
      "field": "contactPhone",
      "mode": "default",
      "displayAlign": "left",
      "isPrimary": false,
      "isReadOnly": false,
      "isExportOnly": false,
      "isUniqueKey": false
    },
    {
      "label": "CreatedAt",
      "field": "contactCreatedAt",
      "mode": "unix",
      "displayAlign": "left",
      "isPrimary": false,
      "isReadOnly": false,
      "isExportOnly": false,
      "isUniqueKey": false
    }
  ],
  "filters": [],
  "schema": {},
  "filterCollection": {},
  "has_odbc": false,
  "encodings": [
    "BASE64",
    "UUENCODE",
    "HTML-ENTITIES",
    "Quoted-Printable",
    "7bit",
    "8bit",
    "UCS-4",
    "UCS-4BE",
    "UCS-4LE",
    "UCS-2",
    "UCS-2BE",
    "UCS-2LE",
    "UTF-32",
    "UTF-32BE",
    "UTF-32LE",
    "UTF-16",
    "UTF-16BE",
    "UTF-16LE",
    "UTF-8",
    "UTF-7",
    "UTF7-IMAP",
    "ASCII",
    "EUC-JP",
    "SJIS",
    "eucJP-win",
    "EUC-JP-2004",
    "SJIS-Mobile#DOCOMO",
    "SJIS-Mobile#KDDI",
    "SJIS-Mobile#SOFTBANK",
    "SJIS-mac",
    "SJIS-2004",
    "UTF-8-Mobile#DOCOMO",
    "UTF-8-Mobile#KDDI-A",
    "UTF-8-Mobile#KDDI-B",
    "UTF-8-Mobile#SOFTBANK",
    "CP932",
    "SJIS-win",
    "CP51932",
    "JIS",
    "ISO-2022-JP",
    "ISO-2022-JP-MS",
    "GB18030",
    "Windows-1252",
    "Windows-1254",
    "ISO-8859-1",
    "ISO-8859-2",
    "ISO-8859-3",
    "ISO-8859-4",
    "ISO-8859-5",
    "ISO-8859-6",
    "ISO-8859-7",
    "ISO-8859-8",
    "ISO-8859-9",
    "ISO-8859-10",
    "ISO-8859-13",
    "ISO-8859-14",
    "ISO-8859-15",
    "ISO-8859-16",
    "EUC-CN",
    "CP936",
    "HZ",
    "EUC-TW",
    "BIG-5",
    "CP950",
    "EUC-KR",
    "UHC",
    "ISO-2022-KR",
    "Windows-1251",
    "CP866",
    "KOI8-R",
    "KOI8-U",
    "ArmSCII-8",
    "CP850",
    "ISO-2022-JP-2004",
    "ISO-2022-JP-MOBILE#KDDI",
    "CP50220",
    "CP50221",
    "CP50222"
  ]
}



Parameters

  • tabularId integer *: The ID of the Tracker Tabular

Export Tracker Import-Export Format


Retrieves the complete export of a tracker import-export format in its configured format

No Tabs


Request URL - tabulars
Copy to clipboard
https://example.com/api/tabulars/{tabularId}/export


cURL - tabulars
Copy to clipboard
curl --request GET \
     --url "https://example.com/api/tabulars/2/export" \
     --header "accept: */*" \
     --header "Authorization: Bearer <API_TOKEN>"


PHP - tabulars
Copy to clipboard
<?php

$tabularId = 2;
$url = "https://example.com/api/tabulars/{$tabularId}/export";

$headers = [
    'Accept: */*',
    'Authorization: Bearer <API_TOKEN>'
];

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($http_code === 200) {
    // If the server returned CSV, print as raw
    $contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
    if (strpos($contentType, 'application/json') !== false) {
        $data = json_decode($response, true);
        print_r($data);
    } else {
        // Likely CSV or another text format
        echo $response;
    }
} else {
    echo 'Error: HTTP status code ' . $http_code;
}

curl_close($ch);

?>


Javascript - tabulars
Copy to clipboard
const tabularId = 2;

fetch('https://example.com/api/tabulars/' + tabularId + '/export', {
  method: 'GET',
  headers: {
    'Accept': '*/*',
    'Authorization': 'Bearer <API_TOKEN>'
  }
})
.then(res => {
  if (!res.ok) throw new Error("HTTP " + res.status);
  const contentType = res.headers.get('content-type');
  if (contentType && contentType.includes('application/json')) {
    return res.json();
  } else {
    return res.text(); // Handle CSV or other text formats
  }
})
.then(data => {
  console.log(data);
})
.catch(err => {
  console.log('Fetch error: ' + err.message);
});


Response - tabulars
Copy to clipboard
Example (CSV):
id,name,email
1,John Doe,john@example.com
2,Jane Smith,jane@example.com

Example (JSON):
[
  {
    "id": 1,
    "name": "John Doe",
    "email": "john@example.com"
  },
  {
    "id": 2,
    "name": "Jane Smith",
    "email": "jane@example.com"
  }
]



Parameters

  • tabularId integer *: The ID of the Tracker Tabular


Import Data via Import-Export Format


Imports data into a tracker using the specified import-export configuration.

No Tabs


Request URL - tabulars
Copy to clipboard
https://example.com/api/tabulars/{tabularId}/import


cURL - tabulars
Copy to clipboard
curl --request POST \
     --url "https://example.com/api/tabulars/2/import" \
     --header "accept: application/json" \
     --header "Authorization: Bearer <API_TOKEN>" \
     --header "Content-Type: multipart/form-data" \
     --form "file=@contact_tabulars.csv;type=text/csv"


PHP - tabulars
Copy to clipboard
<?php

$tabularId = 2;
$url = "https://example.com/api/tabulars/{$tabularId}/import";

$headers = [
    'Accept: application/json',
    'Authorization: Bearer <API_TOKEN>'
];

$postFields = [
    'file' => new CURLFile('contact_tabulars.csv', 'text/csv')
];

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);

$response = curl_exec($ch);

$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($http_code === 200) {
    $data = json_decode($response, true);
    print_r($data);
} else {
    echo 'Error: HTTP status code ' . $http_code;
}

curl_close($ch);

?>


Javascript - tabulars
Copy to clipboard
const tabularId = 2;
const formData = new FormData();
formData.append('file', new File([''], 'contact_tabulars.csv', { type: 'text/csv' }));

fetch('https://example.com/api/tabulars/' + tabularId + '/import', {
  method: 'POST',
  headers: {
    'Accept': 'application/json',
    'Authorization': 'Bearer <API_TOKEN>'
  },
  body: formData
})
.then(res => {
  if (!res.ok) throw new Error("HTTP " + res.status);
  return res.json();
})
.then(data => {
  console.log(data);
})
.catch(err => {
  console.log('Fetch error: ' + err.message);
});


Response - tabulars
Copy to clipboard
[
  {
    "itemId": 1572,
    "contactContactID": 4,
    "contactFirstName": "jobs",
    "contactLastName": "bernard",
    "contactEmail": "jobs@example.com",
    "contactPhone": "7654320",
    "contactCreatedAt": 1104526800
  }
]



Parameters

  • tabularId integer *: The ID of the Tracker Tabular

Delete Data by Primary Keys (Tabular Import-Export)


Deletes records by their primary keys using the configuration defined in the specified import-export format. The data to delete is provided as a file (e.g., CSV) that matches the configured import-export structure.

No Tabs


Request URL - tabulars
Copy to clipboard
https://example.com/api/tabulars/{tabularId}/delete


cURL - tabulars
Copy to clipboard
curl --request POST \
     --url "https://example.com/api/tabulars/2/delete" \
     --header "accept: */*" \
     --header "Authorization: Bearer <API_TOKEN>" \
     --header "Content-Type: multipart/form-data" \
     --form "file=@contact_tabulars.csv;type=text/csv"


PHP - tabulars
Copy to clipboard
<?php

$tabularId = 2;
$url = "https://example.com/api/tabulars/{$tabularId}/delete";

$headers = [
    'Accept: */*',
    'Authorization: Bearer <API_TOKEN>'
];

$postFields = [
    'file' => new CURLFile('contact_tabulars.csv', 'text/csv')
];

$ch = curl_init($url);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);

$response = curl_exec($ch);

$http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if ($http_code === 200) {
    $data = json_decode($response, true);
    print_r($data);
} else {
    echo 'Error: HTTP status code ' . $http_code;
}

curl_close($ch);

?>


Javascript - tabulars
Copy to clipboard
const tabularId = 2;
const formData = new FormData();
formData.append('file', new File([''], 'contact_tabulars.csv', { type: 'text/csv' }));

fetch('https://example.com/api/tabulars/' + tabularId + '/delete', {
  method: 'POST',
  headers: {
    'Accept': '*/*',
    'Authorization': 'Bearer <API_TOKEN>'
  },
  body: formData
})
.then(res => {
  if (!res.ok) throw new Error("HTTP " + res.status);
  return res.json();
})
.then(data => {
  console.log(data);
})
.catch(err => {
  console.log('Fetch error: ' + err.message);
});


Response - tabulars
Copy to clipboard
{
  "feedback": "Your delete request was completed successfully."
}



Parameters

  • tabularId integer *: The ID of the Tracker Tabular




History Source Comments
Show PHP error messages