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.
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["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 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_records.post_dev_api_matrix_list_rows(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.table_name | string | Required within parent | |
body | Model | Required within parent | Expand List Matrix table rows — request body — body |
Referenced models: List Matrix table rows — request body — body
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 List Matrix table rows — response body |
Referenced models: List Matrix table rows — response body
Schemas
Section titled “Schemas”List Matrix table rows — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request for listing Matrix rows. |
external_keys | JSON | Optional | |
external_keys (anyOf 1) | array | Alternative | Filter by specific external keys Default: null |
external_keys (anyOf 1)[] | string | Each item | |
external_keys (anyOf 2) | null | Alternative | |
filters | JSON | Optional | |
filters (anyOf 1) | array | Alternative | Filter rows by input column values. Only rows matching ALL filters are returned. Default: null |
filters (anyOf 1)[] | Model | Each item | Expand List Matrix table rows — request body — body filters array item |
filters (anyOf 2) | null | Alternative | |
page_size | integer | Optional | Number of rows per page Default: 100 |
start | JSON | Optional | |
start (anyOf 1) | string | Alternative | Pagination cursor (row ID from page.next) Default: null |
start (anyOf 2) | null | Alternative |
Referenced models: List Matrix table rows — request body — body filters array item
List Matrix table rows — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response for listing Matrix rows. |
data | array | Required within parent | List of Matrix rows |
data[] | Model | Each item | Expand List Matrix table rows — response body — data item |
page | Model | Required within parent | Expand List Matrix table rows — response body — page Pagination information |
total_count | JSON | Required within parent | |
total_count (anyOf 1) | integer | Alternative | Total number of rows matching filters |
total_count (anyOf 2) | string | Alternative | Pattern: ^-?[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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Filter for a specific Matrix input column. |
column_name | string | Required within parent | API name of the input column to filter on |
one_of | array | Required within parent | List of ramp object UUIDs to filter by (matches any) |
one_of[] | string | Each item |
List Matrix table rows — response body — page
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
next | JSON | Required within parent | |
next (anyOf 1) | string | Alternative | Cursor for next page (row ID to pass as start parameter) |
next (anyOf 2) | null | Alternative |
List Matrix table rows — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Matrix row for reading (GET/list operations). |
id | string | Required within parent | Unique Identifier for this row of the Matrix |
inputs | array | Required within parent | Input cells (ALL input columns included, even if None) |
inputs[] | Model | Each item | Expand List Matrix table rows — response body — data item inputs item |
results | array | Required within parent | Result cells (only cells that exist) |
results[] | Model | Each item | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Matrix result cell with column name, identifier, and display_name (for responses). |
column_name | string | Required within parent | API name of the result column |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Display name of the referenced object (None to clear) |
display_name (anyOf 2) | null | Alternative | |
identifier | JSON | Required within parent | |
identifier (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A Matrix input cell with column name, identifier, and display_name (for responses). |
column_name | string | Required within parent | API name of the input column |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | Display name of the referenced object or number value (None for missing input) |
display_name (anyOf 2) | null | Alternative | |
identifier | JSON | Optional | |
identifier (anyOf 1) | JSON | Alternative | Identifier for the referenced object or number value (includes type discriminator) Default: null |
identifier (anyOf 1) (anyOf 1) | Model | Alternative | Expand List Matrix table rows — response body — data item results item identifier column name, value |
identifier (anyOf 1) (anyOf 2) | Model | Alternative | Expand List Matrix table rows — response body — data item inputs item identifier value value |
identifier (anyOf 2) | null | Alternative |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifier for a native Ramp object (e.g., user, department). |
column_name | string | Required within parent | Column name to identify by (e.g., 'id', 'email') |
value | string | Required within parent | Value for identification |
List Matrix table rows — response body — data item inputs item identifier value value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Identifier for a number value in Matrix input columns. |
value | JSON | Required within parent | |
value (anyOf 1) | number | Alternative | Numeric value (e.g., amount threshold) |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]