Skip to main content
GET
/
v1
/
connect
/
{project_id}
/
components
/
{component_id}
cURL
curl --request GET \
  --url https://api.pipedream.com/v1/connect/{project_id}/components/{component_id} \
  --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,
        "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>"
    }
  }
}

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

​
component_id
string
required

The key that uniquely identifies the component (e.g., 'slack-send-message')

​
project_id
string
required

The project ID, which starts with proj_.

Query Parameters

​
version
string

Optional semantic version of the component to retrieve (for example '1.0.0')

Response

component retrieved

Response received when retrieving a specific component

​
data
object
required