Skip to main content
GET
/
v1
/
connect
/
projects
/
{project_id}
cURL
curl --request GET \
  --url https://api.pipedream.com/v1/connect/projects/{project_id} \
  --header 'Authorization: Bearer <token>'
import { PipedreamClient } from "@pipedream/sdk";

const client = new PipedreamClient({
clientId: "YOUR_CLIENT_ID",
clientSecret: "YOUR_CLIENT_SECRET",
projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
projectId: "YOUR_PROJECT_ID"
});
await client.projects.retrieve("project_id");
from pipedream import Pipedream

client = Pipedream(
project_id="YOUR_PROJECT_ID",
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
client.projects.retrieve(
project_id="project_id",
)
package com.example.usage;

import com.pipedream.api.BaseClient;

public class Example {
public static void main(String[] args) {
BaseClient client = BaseClient.withCredentials("<clientId>", "<clientSecret>")
.build()
;

client.projects().retrieve("project_id");
}
}
package main

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

func main() {

url := "https://api.pipedream.com/v1/connect/projects/{project_id}"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
{
  "id": "<string>",
  "name": "<string>",
  "app_name": "<string>",
  "support_email": "jsmith@example.com",
  "connect_require_key_auth_test": true
}
{
"error": "Throttled"
}

Authorizations

Authorization
string
header
required

A short-lived OAuth access token for server-side requests. Generate one via the Generate OAuth Token flow or automatically when initializing the SDK client.

Path Parameters

project_id
string
required

The project ID, which starts with proj_.

Pattern: ^proj_[a-zA-Z0-9]+$

Response

project retrieved

Project that can be accessed via the Connect API

id
string
required

Hash ID for the project

Pattern: ^proj_[0-9A-Za-z]+$
name
string
required

Display name of the project

app_name
string | null

App name shown to Connect users

support_email
string<email> | null

Support email configured for the project

connect_require_key_auth_test
boolean

Send a test request to the upstream API when adding Connect accounts for key-based apps