--- title: "Retrieve component" method: GET path: "/v1/connect/{project_id}/components/{component_id}" --- # Retrieve component `GET /v1/connect/{project_id}/components/{component_id}` Get detailed configuration for a specific component by its key ## Path parameters - `component_id` string, required ## Query parameters - `version` string ## Headers - `x-pd-environment` 'development' | 'production', required — The environment in which the server client is running ## Response `200` component retrieved - GetComponentResponse — Response received when retrieving a specific component - `data` Component, required - `key` string, required — The key that uniquely identifies the component. - `name` string, required — The human-readable name of the component - `version` string, required — The latest version of the component, in semantic versioning format. - `configurable_props` ConfigurableProp[], required - union — A configuration or input field for a component. This is a discriminated union based on the type field. - ConfigurablePropAlert — This prop is used to configure an alert component - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'alert', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `alertType` 'info' | 'neutral' | 'warning' | 'error' — The severity level of the alert. - `content` string, required — The content of the alert, which can include HTML or plain text. - ConfigurablePropApp — This prop is used to configure an account for a specific app - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'app', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `app` string, required — The name slug of the app, used to identify the app for which the account is being configured. - ConfigurablePropBoolean — This prop can accept a boolean value. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'boolean', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `default` boolean - `options` union[] - union - … - ConfigurablePropDataStore — This prop is used to configure a data store for key-value storage. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'data_store', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - ConfigurablePropDir — This prop is used to indicate how a component may access File Stash - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'dir', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `accessMode` 'read' | 'write' | 'read-write' — The mode in which the component may access File Stash - `sync` boolean — If true, the component's /tmp directory is synchronized with File Stash - ConfigurablePropTimer — This prop is used to configure a timer interface. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` '$.interface.timer', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `static` union — Static timer configuration - TimerInterval — Timer configuration using interval in seconds - … - TimerCron — Timer configuration using cron expression - … - `default` union — Default timer configuration - TimerInterval — Timer configuration using interval in seconds - … - TimerCron — Timer configuration using cron expression - … - `options` ConfigurablePropTimerOption[], nullable — Available timer configuration options - union — Timer configuration options - … - ConfigurablePropApphook — This prop is used to configure an app webhook interface. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` '$.interface.apphook', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `appProp` string, required — The name of the app prop that this apphook depends on - `eventNames` string[], nullable — List of event names to listen for - `remote` boolean, nullable — Whether this apphook is remote - `static` unknown[], nullable — Static configuration for the apphook - unknown - ConfigurablePropIntegerArray — This prop can accept an array of integers. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'integer[]', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `min` integer, nullable — The minimum value for integers in this array - `max` integer, nullable — The maximum value for integers in this array - `default` ConfiguredPropValueInteger[], nullable — Default array of integers - `options` union[], nullable — Available options for the integer array - union - … - ConfigurablePropHttp — This prop is used to configure an HTTP interface. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` '$.interface.http', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `customResponse` boolean, nullable — Whether this HTTP interface allows custom responses - ConfigurablePropHttpRequest — This prop is used to configure an HTTP request with URL, method, headers, params, body, and authentication. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'http_request', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `default` HttpRequestConfig, nullable — Configuration for an HTTP request prop - `auth` HttpRequestAuth, nullable — Authentication configuration for HTTP request - … - `body` HttpRequestBody, nullable — Body configuration for HTTP request - … - `headers` HttpRequestField[], nullable - … - `params` HttpRequestField[], nullable - … - `tab` string, nullable - `method` string, nullable - `url` string, nullable - ConfigurablePropDb — This prop is used to configure a database service. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` '$.service.db', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - ConfigurablePropSql — This prop is used to configure SQL queries. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'sql', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `auth` ConfigurablePropSqlAuth, nullable - `app` string — The app that provides SQL authentication - `default` ConfiguredPropValueSql - `value` string, required — The raw SQL query, as provided by the user - `query` string, required — The SQL query to execute - `params` string[], required — The list of parameters for the prepared statement - `usePreparedStatements` boolean, required — Whether to use prepared statements for the query or not - `options` union[] - union - … - ConfigurablePropAirtableBaseId — This prop is used to select an Airtable base. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` '$.airtable.baseId', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `appProp` string, required — The name of the app prop that provides Airtable authentication - ConfigurablePropAirtableTableId — This prop is used to select an Airtable table. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` '$.airtable.tableId', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `baseIdProp` string, required — The name of the prop that provides the Airtable base ID - ConfigurablePropAirtableViewId — This prop is used to select an Airtable view. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` '$.airtable.viewId', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `tableIdProp` string, required — The name of the prop that provides the Airtable table ID - ConfigurablePropAirtableFieldId — This prop is used to select an Airtable field. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` '$.airtable.fieldId', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `tableIdProp` string, required — The name of the prop that provides the Airtable table ID - ConfigurablePropDiscordChannel — This prop is used to select a Discord channel. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` '$.discord.channel', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `appProp` string, required — The name of the app prop that provides Discord authentication - ConfigurablePropDiscordChannelArray — This prop is used to select multiple Discord channels. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` '$.discord.channel[]', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `appProp` string — The name of the app prop that provides Discord authentication - ConfigurablePropInteger — This prop can accept an integer value. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'integer', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `min` integer, nullable — The minimum value for this integer prop. - `max` integer, nullable — The maximum value for this integer prop. - `default` number - `options` union[], nullable — Available integer options - union - … - ConfigurablePropString — This prop can accept a string value. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'string', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `secret` boolean, nullable — If true, this prop is a secret and should not be displayed in plain text. - `format` 'file-ref', nullable — The format of the string value. `file-ref` indicates a URL of a file or path to a file in the component's /tmp directory. - `default` string - `options` union[] - union - … - ConfigurablePropStringArray — This prop can accept an array of strings. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'string[]', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `secret` boolean, nullable — If true, this prop is a secret and should not be displayed in plain text. - `format` 'file-ref', nullable — The format of the string value. `file-ref` indicates a URL of a file or path to a file in the component's /tmp directory. - `default` ConfiguredPropValueString[], nullable — The default value for this prop - `options` union[] - union - … - ConfigurablePropObject — This prop can accept a set of key-value pairs. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'object', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `default` ConfiguredPropValueObject - `options` union[] - union - … - ConfigurablePropAny — This prop can accept any value. - `name` string, required — When building `configuredProps`, make sure to use this field as the key when setting the prop value - `type` 'any', required - `label` string, nullable — Value to use as an input label. In cases where `type` is "app", should load the app via `getApp`, etc. and show `app.name` instead. - `description` string, nullable — A description of the prop, shown to the user when configuring the component. - `optional` boolean, nullable — If true, this prop does not need to be specified. - `disabled` boolean, nullable — If true, this prop will be ignored. - `readOnly` boolean, nullable — If true, this prop is read-only — its value is either fixed by the component author (`static`) or the prop is purely informational (e.g. `alert`, `dir`). Connect clients should render it without treating it as a configurable input. - `hidden` boolean, nullable — If true, should not expose this prop to the user - `remoteOptions` boolean, nullable — If true, call `configureComponent` for this prop to load remote options. It is safe, and preferred, given a returned list of { label: string; value: any } objects to set the prop value to { __lv: { label: string; value: any } }. This way, on load, you can access label for the value without necessarily reloading these options - `useQuery` boolean, nullable — If true, calls to `configureComponent` for this prop support receiving a `query` parameter to filter remote options - `reloadProps` boolean, nullable — If true, after setting a value for this prop, a call to `reloadComponentProps` is required as the component has dynamic configurable props dependent on this one - `withLabel` boolean, nullable — If true, you must save the configured prop value as a "label-value" object which should look like: { __lv: { label: string; value: any } } because the execution needs to access the label - `default` unknown - `options` union[] - union - … - `description` string, nullable — A description of the component - `component_type` string, nullable — The type of component (trigger or action) - `stash` 'optional' | 'required', nullable — Indicates if a File Stash ID is optional or required to run the component - `annotations` ToolAnnotations, nullable — Optional properties describing component behavior - `destructiveHint` boolean, nullable — If true, the component may perform destructive updates to its environment. If false, the component performs only additive updates. - `idempotentHint` boolean, nullable — If true, calling the component repeatedly with the same arguments will have no additional effect on the its environment. - `openWorldHint` boolean, nullable — If true, this component may interact with an “open world” of external entities. If false, the component's domain of interaction is closed. For example, the world of a web search component is open, whereas that of a memory component is not. - `readOnlyHint` boolean, nullable — If true, the component does not modify its environment. - `title` string, nullable — A human-readable title for the component. ## Other responses - `429` — too many requests --- [API](https://skmtc.net/pipedream/apis/pipedream-rest-api.md) · [All operations](https://skmtc.net/pipedream/apis/pipedream-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pipedream/pipedream-rest-api/versions/c25dbf225c49/schema)