Skip to content

Ramp: List Custom Column values for rows of a Native Ramp table

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

← Custom records operations · Get started

Operation ramp.get_dev_api_native_row

Provider route: GET /developer/v1/custom-records/native-tables/{native_table_name}/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"]["getDevApiNativeRow"]>[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.getDevApiNativeRow(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_native_row(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.native_table_namestringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.include_all_referenced_rowsbooleanOptionalInclude all referenced rows in each cell rather than a subset of them.
Default: false
query.page_sizeintegerOptionalNumber of rows to include in the response. Max: 100
Default: 50
query.ramp_idJSONOptional
query.ramp_id (anyOf 1)arrayAlternativeid of the Ramp object
Default: null
query.ramp_id (anyOf 1)[]stringEach item
query.ramp_id (anyOf 2)nullAlternative
query.startJSONOptional
query.start (anyOf 1)stringAlternativeThe value of the `next` field from the previous response, if any
Default: null
query.start (anyOf 2)nullAlternative

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List Custom Table rows — response body

Referenced models: List Custom Table rows — response body

List Custom Table rows — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List Custom Table rows — response body — data item
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, List Custom Table rows — response body — data item

List bills — response body — page
FieldTypePresenceDescription and constraints
$objectRootPagination details for a Developer API response.
nextJSONRequired within parent
next (anyOf 1)stringAlternativethe query to get to the next page; it is in the format of <BASE_URL>?<new_params>
next (anyOf 2)nullAlternative
List Custom Table rows — response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
cellsarrayRequired within parentThe contents of each column for this row.
cells[]ModelEach itemExpand Get a business entity — response body — custom record fields item
display_namestringRequired within parentA display name for the custom row.
external_keystringRequired within parentThe external key of the custom row. Will be unique within the table.
idstringRequired within parentThe id of the custom row

Referenced models: Get a business entity — response body — custom record fields item

Get a business entity — response body — custom record fields item
FieldTypePresenceDescription and constraints
$objectRoot
column_display_namestringRequired within parentThe display name of the column
column_idstringRequired within parentThe id of the column
valueJSONRequired within parentThe contents of the cell
discriminator: {"mapping": {"boolean": "#/components/schemas/BooleanCellContentsForDisplay", "custom_table": "#/components/schemas/CustomTableReferenceCellContentsForDisplay", "date": "#/components/schemas/DatetimeCellContentsForDisplay", "native_table": "#/components/schemas/NativeTableReferenceCellContentsForDisplay", "number": "#/components/schemas/NumberCellContentsForDisplay", "text": "#/components/schemas/TextCellContentsForDisplay"}, "propertyName": "type"}
value (anyOf 1)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type boolean
value (anyOf 2)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type custom table
value (anyOf 3)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type date
value (anyOf 4)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type native table
value (anyOf 5)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type number
value (anyOf 6)ModelAlternativeExpand Get a business entity — response body — custom record fields item value type text

Referenced models: Get a business entity — response body — custom record fields item value type boolean, Get a business entity — response body — custom record fields item value type date, Get a business entity — response body — custom record fields item value type custom table, Get a business entity — response body — custom record fields item value type native table, Get a business entity — response body — custom record fields item value type number, Get a business entity — response body — custom record fields item value type text

Get a business entity — response body — custom record fields item value type boolean
FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
typestringRequired within parentMust equal: boolean
valuebooleanRequired within parent
Get a business entity — response body — custom record fields item value type date
FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
typestringRequired within parentMust equal: date
valuestringRequired within parentFormat: date-time
Get a business entity — response body — custom record fields item value type custom table
FieldTypePresenceDescription and constraints
$objectRoot
has_morebooleanRequired within parentIndicates if there are more rows in the table than are included in this response
rowsarrayRequired within parentThe rows referenced by this cell
rows[]ModelEach itemExpand Get a business entity — response body — custom record fields item value type custom table rows item
table_namestringRequired within parentThe custom table that referenced rows are part of
typestringRequired within parentMust equal: custom_table

Referenced models: Get a business entity — response body — custom record fields item value type custom table rows item

Get a business entity — response body — custom record fields item value type native table
FieldTypePresenceDescription and constraints
$objectRoot
has_morebooleanRequired within parentIndicates if there are more rows in the table than are included in this response
rowsarrayRequired within parentThe rows referenced by this cell
rows[]ModelEach itemExpand Get a business entity — response body — custom record fields item value type native table rows item
table_namestringRequired within parentThe native table that referenced rows are part of
Known values: accounting_field_options, approver_groups, bills, business_entities, cards, contracts, departments, external_attendees, limits, locations, merchant_categories, purchase_order_line_items, purchase_orders, reimbursements, transactions, users, vendors
typestringRequired within parentMust equal: native_table

Referenced models: Get a business entity — response body — custom record fields item value type native table rows item

Get a business entity — response body — custom record fields item value type number
FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
typestringRequired within parentMust equal: number
valueJSONRequired within parent
value (anyOf 1)numberAlternative
value (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Get a business entity — response body — custom record fields item value type text
FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
typestringRequired within parentMust equal: text
valuestringRequired within parent
Get a business entity — response body — custom record fields item value type custom table rows item
FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
external_keystringRequired within parentThe external key of the row
row_idstringRequired within parentThe id of the row
typestringRequired within parentKnown values: custom_table
Default: custom_table
Get a business entity — response body — custom record fields item value type native table rows item
FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
external_keystringRequired within parentThe id of the Ramp object
typestringRequired within parentKnown values: native_table
Default: native_table

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