Ramp: Fetch a custom form collection response by ID
Ramp customForm.getCustomFormCollectionResponseResource: arguments, response, policy and SDK examples.
← Custom form operations · Get started
Operation ramp.get_custom_form_collection_response_resource
Provider route: GET /developer/v1/custom-form/collections/responses/{custom_form_collection_response_id}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["customForm"]["getCustomFormCollectionResponseResource"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.customForm.getCustomFormCollectionResponseResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.custom_form.get_custom_form_collection_response_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.custom_form_collection_response_id | string | Required within parent |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Fetch a custom form collection response by ID — response body |
Referenced models: Fetch a custom form collection response by ID — response body
Schemas
Section titled “Schemas”109 more schemas are linked from the tables above, on the schema pages.
Fetch a custom form collection response by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_form_collection_response | Model | Required within parent | Expand Fetch a custom form collection response by ID — response body — custom form collection response The custom form collection with response data. |
id | string | Required within parent | Unique identifier of the custom form collection response. Format: uuid |
Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response
Fetch a custom form collection response by ID — response body — custom form collection response
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
custom_form_collection_log_entry | JSON | Required within parent | |
custom_form_collection_log_entry (anyOf 1) | Model | Alternative | Expand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label Log entry for response to a custom form collection. |
custom_form_collection_log_entry (anyOf 2) | null | Alternative |
Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label
Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
allow_comments | boolean | Required within parent | Whether comments are allowed on field responses. |
forms | array | Required within parent | The custom forms and responses associated with the response log entry. |
forms[] | Model | Each item | Expand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item |
label | JSON | Required within parent | |
label (anyOf 1) | string | Alternative | The label for the response log entry. |
label (anyOf 2) | null | Alternative |
Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item
Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fields | array | Required within parent | The fields for the custom form responses. |
fields[] | Model | Each item | Expand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item |
label | JSON | Required within parent | |
label (anyOf 1) | string | Alternative | The label for the custom form. |
label (anyOf 2) | null | Alternative |
Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item validation errors item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Required within parent |
Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
condition | Model | Required within parent | Expand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition |
then | array | Required within parent | |
then[] | Model | Each item | Expand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item |
Referenced models: Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then condition, Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item conditions condition, then then item
Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item approval workflow references array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
branch_id | JSON | Optional | |
branch_id (anyOf 1) | string | Alternative | Condition branch identifier, when available. Default: null |
branch_id (anyOf 2) | null | Alternative | |
branch_index | JSON | Optional | |
branch_index (anyOf 1) | JSON | Alternative | |
branch_index (anyOf 1) (anyOf 1) | integer | Alternative | Condition branch position for historical fallback. Default: null |
branch_index (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
branch_index (anyOf 2) | null | Alternative | |
kind | string | Required within parent | Whether the question is used by a condition or approval step. Known values: APPROVAL_STEP, CONDITION |
label | JSON | Optional | |
label (anyOf 1) | string | Alternative | Branch or approval step label; null when unnamed. Default: null |
label (anyOf 2) | null | Alternative | |
node_id | string | Required within parent | Referencing workflow graph node identifier. |
referenced_choice_labels | array | Optional | Choice labels referenced by the condition. |
referenced_choice_labels[] | string | Each item | |
template_id | string | Required within parent | Exact workflow template version inspected. Format: uuid |
workflow_id | string | Required within parent | Workflow containing the reference. Format: uuid |
Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field mapping references item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
approval_trigger_metadata_uuid | string | Required within parent | UUID of the approval-step metadata that owns the field mapping. |
node_id | JSON | Optional | |
node_id (anyOf 1) | string | Alternative | Consuming node in a current or draft workflow, or null when none exists. Default: null |
node_id (anyOf 2) | null | Alternative | |
remote_system | Model | Required within parent | Expand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item field mapping references item remote system Integration provider that consumes the mapped question. |
workflow_id | JSON | Optional | |
workflow_id (anyOf 1) | string | Alternative | Blank canvas workflow that owns node_id, or null when node_id is null or the node is in a subflow. Default: null |
workflow_id (anyOf 2) | null | Alternative |
Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Public-facing dump of a RampDocument container plus its latest version. |
created_at | string | Required within parent | Format: date-time |
id | string | Required within parent | |
latest_version | Model | Required within parent | Expand Fetch a custom form collection response by ID — response body — custom form collection response custom form collection log entry allow comments, forms, label forms item fields item attachments item latest version |
version_count | JSON | Required within parent | |
version_count (anyOf 1) | integer | Alternative | |
version_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
version_type | string | Required within parent | Known values: GENERIC, PAYEE, PROCUREMENT, TAX_EXEMPTION_CERTIFICATE, WBX |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_custom_form_collection_response_resource. Catalog operation: get_custom_form_collection_response_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["custom_forms:read"]