Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.custom_form_collection_response_idstringRequired within parent

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Fetch a custom form collection response by ID — response body

Referenced models: Fetch a custom form collection response by ID — response body

109 more schemas are linked from the tables above, on the schema pages.

Fetch a custom form collection response by ID — response body
FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collection_responseModelRequired within parentExpand Fetch a custom form collection response by ID — response body — custom form collection response
The custom form collection with response data.
idstringRequired within parentUnique 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
FieldTypePresenceDescription and constraints
$objectRoot
custom_form_collection_log_entryJSONRequired within parent
custom_form_collection_log_entry (anyOf 1)ModelAlternativeExpand 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)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
allow_commentsbooleanRequired within parentWhether comments are allowed on field responses.
formsarrayRequired within parentThe custom forms and responses associated with the response log entry.
forms[]ModelEach itemExpand 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
labelJSONRequired within parent
label (anyOf 1)stringAlternativeThe label for the response log entry.
label (anyOf 2)nullAlternative

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
FieldTypePresenceDescription and constraints
$objectRoot
fieldsarrayRequired within parentThe fields for the custom form responses.
fields[]ModelEach itemExpand 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
labelJSONRequired within parent
label (anyOf 1)stringAlternativeThe label for the custom form.
label (anyOf 2)nullAlternative

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

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
FieldTypePresenceDescription and constraints
$objectRoot
messagestringRequired 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
FieldTypePresenceDescription and constraints
$objectRoot
conditionModelRequired within parentExpand 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
thenarrayRequired within parent
then[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRoot
branch_idJSONOptional
branch_id (anyOf 1)stringAlternativeCondition branch identifier, when available.
Default: null
branch_id (anyOf 2)nullAlternative
branch_indexJSONOptional
branch_index (anyOf 1)JSONAlternative
branch_index (anyOf 1) (anyOf 1)integerAlternativeCondition branch position for historical fallback.
Default: null
branch_index (anyOf 1) (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
branch_index (anyOf 2)nullAlternative
kindstringRequired within parentWhether the question is used by a condition or approval step.
Known values: APPROVAL_STEP, CONDITION
labelJSONOptional
label (anyOf 1)stringAlternativeBranch or approval step label; null when unnamed.
Default: null
label (anyOf 2)nullAlternative
node_idstringRequired within parentReferencing workflow graph node identifier.
referenced_choice_labelsarrayOptionalChoice labels referenced by the condition.
referenced_choice_labels[]stringEach item
template_idstringRequired within parentExact workflow template version inspected.
Format: uuid
workflow_idstringRequired within parentWorkflow 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
FieldTypePresenceDescription and constraints
$objectRoot
approval_trigger_metadata_uuidstringRequired within parentUUID of the approval-step metadata that owns the field mapping.
node_idJSONOptional
node_id (anyOf 1)stringAlternativeConsuming node in a current or draft workflow, or null when none exists.
Default: null
node_id (anyOf 2)nullAlternative
remote_systemModelRequired within parentExpand 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_idJSONOptional
workflow_id (anyOf 1)stringAlternativeBlank 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)nullAlternative

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 field mapping references item remote system

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
FieldTypePresenceDescription and constraints
$objectRootPublic-facing dump of a RampDocument container plus its latest version.
created_atstringRequired within parentFormat: date-time
idstringRequired within parent
latest_versionModelRequired within parentExpand 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_countJSONRequired within parent
version_count (anyOf 1)integerAlternative
version_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
version_typestringRequired within parentKnown values: GENERIC, PAYEE, PROCUREMENT, TAX_EXEMPTION_CERTIFICATE, WBX

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 attachments item latest version

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"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.