Skip to main content
GET
/
api
/
vendor
/
connections
/
Get Vendor Connections
curl --request GET \
  --url https://{env}.tartanhq.com/api/vendor/connections/ \
  --header 'Authorization: <api-key>'
import requests

url = "https://{env}.tartanhq.com/api/vendor/connections/"

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

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

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

fetch('https://{env}.tartanhq.com/api/vendor/connections/', 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://{env}.tartanhq.com/api/vendor/connections/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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://{env}.tartanhq.com/api/vendor/connections/"

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

	req.Header.Add("Authorization", "<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://{env}.tartanhq.com/api/vendor/connections/")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{env}.tartanhq.com/api/vendor/connections/")

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

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

response = http.request(request)
puts response.read_body
{
  "message": "success",
  "pageInfo": {
    "totalPages": 6,
    "totalItems": 59,
    "items": 10,
    "next": true,
    "previous": false
  },
  "data": [
    {
      "org_name": "<string>",
      "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shared_data_points": [
        "<string>"
      ],
      "not_shared_data_points": [
        "<string>"
      ],
      "not_requested_data_points": [
        "<string>"
      ],
      "last_successful_sync": "10th July, 01:11 PM",
      "sync_frequency": "<string>",
      "hrms_code": "<string>",
      "csm_user": "<string>",
      "application_status_timestamp": "10th July, 12:55 PM",
      "created_by_user": "<string>",
      "int_type": "Upload CSV",
      "email": "jsmith@example.com",
      "phone": "<string>",
      "is_international": true,
      "salary_details_flag": true,
      "application_connection_status": "Active"
    }
  ]
}
{
  "requestId": "595e4f6f-5c53-4b70-8230-a5572da1ad5d",
  "message": "Invalid token.",
  "data": "<string>"
}
{
  "requestId": "10d62daa-16ea-4960-84ba-916c20548352",
  "message": "Internal Server Error",
  "data": "<string>"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
status
enum<string>

Filter connections by status (e.g., pending, approved).

Available options:
pending,
approved,
rejected

Response

Successful response

​
message
string
Example:

"success"

​
pageInfo
object
​
data
object[]