Proxy GET request to connected app account

Makes a GET request to an external API on behalf of a connected app account. The Pipedream proxy handles OAuth credential injection and forwards the request to the target API endpoint.

GET /app_accounts/{account_id}/proxy

Proxy GET request to connected app account

cURL

curl --request GET \
  --url https://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy \
  --header 'X-API-Key: <api-key>'

import requests

url = "https://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy"

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://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy', 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.kapso.ai/api/v1/app_accounts/{account_id}/proxy",
  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://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy"

	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://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy")
  .header("X-API-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/app_accounts/{account_id}/proxy")

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

200

{
  "ok": true,
  "channels": [
    {
      "id": "C123",
      "name": "general"
    }
  ]
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "App integrations addon is not enabled. Please enable it in billing settings."
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Proxy request failed"
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Headers

X-Target-URL · string<uri>

Alternative way to specify target URL via header

Example:

"https://slack.com/api/conversations.list"

X-PD-Proxy-* · string

Custom headers to forward to the target API. Use X-PD-Proxy- prefix. Example: X-PD-Proxy-Content-Type will be forwarded as Content-Type

Path Parameters

account_id · string · required

The Pipedream account ID for the connected app

Example:

"apn_1234567"

Query Parameters

url · string<uri> · required

The target API endpoint URL

Example:

"https://slack.com/api/conversations.list"

Response

200

application/json

Successful proxy request

Response from the target API