Skip to main content
GET
/
v1
/
connect
/
projects
cURL
curl --request GET \
  --url https://api.pipedream.com/v1/connect/projects \
  --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"
});
const pageableResponse = await client.projects.list({
after: "after",
before: "before",
limit: 1,
q: "q"
});
for await (const item of pageableResponse) {
console.log(item);
}

// Or you can manually iterate page-by-page
let page = await client.projects.list({
after: "after",
before: "before",
limit: 1,
q: "q"
});
while (page.hasNextPage()) {
page = page.getNextPage();
}

// You can also access the underlying response
const response = page.response;
from pipedream import Pipedream

client = Pipedream(
project_id="YOUR_PROJECT_ID",
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
response = client.projects.list(
after="after",
before="before",
limit=1,
q="q",
)
for item in response:
yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
yield page
package com.example.usage;

import com.pipedream.api.BaseClient;
import com.pipedream.api.resources.projects.requests.ProjectsListRequest;

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

client.projects().list(
ProjectsListRequest
.builder()
.after("after")
.before("before")
.limit(1)
.q("q")
.build()
);
}
}
package main

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

func main() {

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

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))

}
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "app_name": "<string>",
      "support_email": "jsmith@example.com",
      "connect_require_key_auth_test": true
    }
  ],
  "page_info": {
    "count": 10,
    "total_count": 120,
    "start_cursor": "<string>",
    "end_cursor": "<string>"
  }
}
{
"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.

Query Parameters

after
string

The cursor to start from for pagination

before
string

The cursor to end before for pagination

limit
integer

The maximum number of results to return

q
string

A search query to filter the projects

Response

projects listed

Response received when listing Connect projects

data
object[]
required
page_info
object
required