Skip to main content
GET
/
v1
/
connect
/
{project_id}
/
components
cURL
curl --request GET \
  --url https://api.pipedream.com/v1/connect/{project_id}/components \
  --header 'Authorization: Bearer <token>' \
  --header 'x-pd-environment: <x-pd-environment>'
{
  "data": [
    {
      "key": "<string>",
      "name": "<string>",
      "version": "<string>",
      "configurable_props": [
        {
          "name": "<string>",
          "type": "alert",
          "content": "<string>",
          "label": "<string>",
          "description": "<string>",
          "optional": true,
          "disabled": true,
          "readOnly": true,
          "hidden": true,
          "remoteOptions": true,
          "useQuery": true,
          "reloadProps": true,
          "withLabel": true,
          "alertType": "info"
        }
      ],
      "description": "<string>",
      "component_type": "<string>",
      "stash": "optional",
      "annotations": {
        "destructiveHint": true,
        "idempotentHint": true,
        "openWorldHint": true,
        "readOnlyHint": true,
        "title": "<string>"
      }
    }
  ],
  "page_info": {
    "count": 10,
    "total_count": 120,
    "start_cursor": "<string>",
    "end_cursor": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://pipedream.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

A short-lived Connect token for client-side requests on behalf of an end user. Generate one via the Create Connect token endpoint.

Headers

​
x-pd-environment
enum<string>
required

The environment in which the server client is running

Available options:
development,
production

Path Parameters

​
project_id
string
required

The project ID, which starts with proj_.

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

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 components

​
app
string

The ID or name slug of the app to filter the components

​
registry
enum<string>

The registry to retrieve components from. Defaults to 'all' ('public', 'private', or 'all')

Available options:
public,
private,
all
​
component_type
enum<string>

The type of the component to filter the components The type of component (trigger or action)

Available options:
trigger,
action

Response

returns public + private without permission

Response received when retrieving a list of components

​
data
object[]
required
​
page_info
object
required