Skip to content

Ramp: List all Matrix tables for the business

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

← Custom records operations · Get started

Operation ramp.get_dev_api_matrix_tables

Provider route: GET /developer/v1/custom-records/matrix-tables. 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"]["getDevApiMatrixTables"]>[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.getDevApiMatrixTables(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.get_dev_api_matrix_tables(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List all Matrix tables for the business — response body

Referenced models: List all Matrix tables for the business — response body

List all Matrix tables for the business — response body
FieldTypePresenceDescription and constraints
$objectRootResponse for listing Matrix tables.
dataarrayRequired within parentList of Matrix tables
data[]ModelEach itemExpand List all Matrix tables for the business — response body — data item

Referenced models: List all Matrix tables for the business — response body — data item

List all Matrix tables for the business — response body — data item
FieldTypePresenceDescription and constraints
$objectRootInfo about a Matrix table for Developer API (uses UUIDs).
idstringRequired within parentTable ID
input_columnsarrayRequired within parentInput columns
input_columns[]ModelEach itemExpand List all Matrix tables for the business — response body — data item input columns item
labelstringRequired within parentDisplay name
namestringRequired within parentAPI name
result_columnsarrayRequired within parentResult columns
result_columns[]ModelEach itemExpand List all Matrix tables for the business — response body — data item result columns item

Referenced models: List all Matrix tables for the business — response body — data item input columns item, List all Matrix tables for the business — response body — data item result columns item

List all Matrix tables for the business — response body — data item input columns item
FieldTypePresenceDescription and constraints
$objectRootInfo about a Matrix input column for Developer API (uses UUIDs).
display_namestringRequired within parentDisplay name
idstringRequired within parentColumn ID
namestringRequired within parentAPI name
typeJSONRequired within parentColumn type details (native_reference or number)
type (anyOf 1)ModelAlternativeExpand List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference
type (anyOf 2)ModelAlternativeExpand List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: number

Referenced models: List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference, List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: number

List all Matrix tables for the business — response body — data item result columns item
FieldTypePresenceDescription and constraints
$objectRootInfo about a Matrix result column for Developer API (uses UUIDs).
display_namestringRequired within parentDisplay name
idstringRequired within parentColumn ID
namestringRequired within parentAPI name
typeModelRequired within parentExpand List all Matrix tables for the business — response body — data item result columns item type
Column type details (currently only native_reference)

Referenced models: List all Matrix tables for the business — response body — data item result columns item type

List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference
FieldTypePresenceDescription and constraints
$objectRootType info for native reference Matrix input columns (Developer API).
column_typestringOptionalColumn type discriminator
Known values: native_reference
Default: native_reference
native_tableModelRequired within parentExpand List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference native table

Referenced models: List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference native table

List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: number
FieldTypePresenceDescription and constraints
$objectRootType info for number Matrix input columns (Developer API).
column_typestringOptionalColumn type discriminator
Known values: number
Default: number
List all Matrix tables for the business — response body — data item result columns item type
FieldTypePresenceDescription and constraints
$objectRootType info for native reference Matrix result columns (Developer API).
cardinalitystringRequired within parentCardinality enum for Pydantic schemas with lowercase values.

This enum uses lowercase values for API consistency while mapping
to the internal CardinalityEnum.
Known values: many_to_many, many_to_one
column_typestringOptionalColumn type discriminator
Known values: native_reference
Default: native_reference
native_tableModelRequired within parentExpand List all Matrix tables for the business — response body — data item result columns item type native table

Referenced models: List all Matrix tables for the business — response body — data item result columns item type native table

List all Matrix tables for the business — response body — data / item / input_columns / item / type / column_type: native reference native table
FieldTypePresenceDescription and constraints
$objectRootNative table reference for Developer API input columns.

Allows: users, locations, departments, business_entities, accounting_field_options, vendors,
and merchant_categories.
accounting_field_ramp_idJSONOptional
accounting_field_ramp_id (anyOf 1)stringAlternativeThe accounting field's ramp_id (UUID), only set for accounting_field_options
Default: null
accounting_field_ramp_id (anyOf 2)nullAlternative
table_namestringRequired within parentThe native table name for input columns: users, locations, departments, business_entities, accounting_field_options, vendors, merchant_categories.
Known values: accounting_field_options, business_entities, departments, locations, merchant_categories, users, vendors
typestringOptionalKnown values: native_table
Default: native_table
List all Matrix tables for the business — response body — data item result columns item type native table
FieldTypePresenceDescription and constraints
$objectRootNative table reference for Developer API result columns.

Only allows: users, approver_groups, and accounting_field_options.
accounting_field_ramp_idJSONOptional
accounting_field_ramp_id (anyOf 1)stringAlternativeThe accounting field's ramp_id (UUID), only set for accounting_field_options
Default: null
accounting_field_ramp_id (anyOf 2)nullAlternative
table_namestringRequired within parentThe native table name for result columns: users, approver_groups, or accounting_field_options only.
Known values: accounting_field_options, approver_groups, users
typestringOptionalKnown values: native_table
Default: native_table

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