Skip to content

Ramp: List Matrix table rows

Ramp customRecords.postDevApiMatrixListRows: arguments, response, policy and SDK examples.

← Custom records operations · Get started

Operation ramp.post_dev_api_matrix_list_rows

Provider route: POST /developer/v1/custom-records/matrix-tables/{table_name}/list-rows. 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["customRecords"]["postDevApiMatrixListRows"]>[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.customRecords.postDevApiMatrixListRows(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_records.post_dev_api_matrix_list_rows(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.table_namestringRequired within parent
bodyModelRequired within parentExpand List Matrix table rows — request body — body

Referenced models: List Matrix table rows — request body — body

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List Matrix table rows — response body

Referenced models: List Matrix table rows — response body

List Matrix table rows — request body — body
FieldTypePresenceDescription and constraints
$objectRootRequest for listing Matrix rows.
external_keysJSONOptional
external_keys (anyOf 1)arrayAlternativeFilter by specific external keys
Default: null
external_keys (anyOf 1)[]stringEach item
external_keys (anyOf 2)nullAlternative
filtersJSONOptional
filters (anyOf 1)arrayAlternativeFilter rows by input column values. Only rows matching ALL filters are returned.
Default: null
filters (anyOf 1)[]ModelEach itemExpand List Matrix table rows — request body — body filters array item
filters (anyOf 2)nullAlternative
page_sizeintegerOptionalNumber of rows per page
Default: 100
startJSONOptional
start (anyOf 1)stringAlternativePagination cursor (row ID from page.next)
Default: null
start (anyOf 2)nullAlternative

Referenced models: List Matrix table rows — request body — body filters array item

List Matrix table rows — response body
FieldTypePresenceDescription and constraints
$objectRootResponse for listing Matrix rows.
dataarrayRequired within parentList of Matrix rows
data[]ModelEach itemExpand List Matrix table rows — response body — data item
pageModelRequired within parentExpand List Matrix table rows — response body — page
Pagination information
total_countJSONRequired within parent
total_count (anyOf 1)integerAlternativeTotal number of rows matching filters
total_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Matrix table rows — response body — page, List Matrix table rows — response body — data item

List Matrix table rows — request body — body filters array item
FieldTypePresenceDescription and constraints
$objectRootFilter for a specific Matrix input column.
column_namestringRequired within parentAPI name of the input column to filter on
one_ofarrayRequired within parentList of ramp object UUIDs to filter by (matches any)
one_of[]stringEach item
List Matrix table rows — response body — page
FieldTypePresenceDescription and constraints
$objectRoot
nextJSONRequired within parent
next (anyOf 1)stringAlternativeCursor for next page (row ID to pass as start parameter)
next (anyOf 2)nullAlternative
List Matrix table rows — response body — data item
FieldTypePresenceDescription and constraints
$objectRootA Matrix row for reading (GET/list operations).
idstringRequired within parentUnique Identifier for this row of the Matrix
inputsarrayRequired within parentInput cells (ALL input columns included, even if None)
inputs[]ModelEach itemExpand List Matrix table rows — response body — data item inputs item
resultsarrayRequired within parentResult cells (only cells that exist)
results[]ModelEach itemExpand List Matrix table rows — response body — data item results item

Referenced models: List Matrix table rows — response body — data item results item, List Matrix table rows — response body — data item inputs item

List Matrix table rows — response body — data item results item
FieldTypePresenceDescription and constraints
$objectRootA Matrix result cell with column name, identifier, and display_name (for responses).
column_namestringRequired within parentAPI name of the result column
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeDisplay name of the referenced object (None to clear)
display_name (anyOf 2)nullAlternative
identifierJSONRequired within parent
identifier (anyOf 1)ModelAlternativeExpand List Matrix table rows — response body — data item results item identifier column name, value
Identifier for the referenced object (None to clear)
identifier (anyOf 2)nullAlternative

Referenced models: List Matrix table rows — response body — data item results item identifier column name, value

List Matrix table rows — response body — data item inputs item
FieldTypePresenceDescription and constraints
$objectRootA Matrix input cell with column name, identifier, and display_name (for responses).
column_namestringRequired within parentAPI name of the input column
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeDisplay name of the referenced object or number value (None for missing input)
display_name (anyOf 2)nullAlternative
identifierJSONOptional
identifier (anyOf 1)JSONAlternativeIdentifier for the referenced object or number value (includes type discriminator)
Default: null
identifier (anyOf 1) (anyOf 1)ModelAlternativeExpand List Matrix table rows — response body — data item results item identifier column name, value
identifier (anyOf 1) (anyOf 2)ModelAlternativeExpand List Matrix table rows — response body — data item inputs item identifier value value
identifier (anyOf 2)nullAlternative

Referenced models: List Matrix table rows — response body — data item results item identifier column name, value, List Matrix table rows — response body — data item inputs item identifier value value

List Matrix table rows — response body — data item results item identifier column name, value
FieldTypePresenceDescription and constraints
$objectRootIdentifier for a native Ramp object (e.g., user, department).
column_namestringRequired within parentColumn name to identify by (e.g., 'id', 'email')
valuestringRequired within parentValue for identification
List Matrix table rows — response body — data item inputs item identifier value value
FieldTypePresenceDescription and constraints
$objectRootIdentifier for a number value in Matrix input columns.
valueJSONRequired within parent
value (anyOf 1)numberAlternativeNumeric value (e.g., amount threshold)
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: ramp.post_dev_api_matrix_list_rows. Catalog operation: post_dev_api_matrix_list_rows. 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_records: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.