Skip to content

Ramp: List Custom Columns for a Native Ramp table

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

← Custom records operations · Get started

Operation ramp.get_dev_api_native_table_column

Provider route: GET /developer/v1/custom-records/native-tables/{native_table_name}/columns. 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"]["getDevApiNativeTableColumn"]>[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.getDevApiNativeTableColumn(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_table_column(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

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 columns — response body

Referenced models: List Custom Table columns — response body

List Custom Table columns — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand List Custom Table columns — 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 columns — 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 columns — response body — data item
FieldTypePresenceDescription and constraints
$objectRoot
allows_writesbooleanRequired within parentWhether the column can be directly written to. Columns not directly written to have values derived from columns that reference them.
display_namestringRequired within parentThe display name of the column
idstringRequired within parentThe unique identifier for the column
namestringRequired within parentThe name of the column, to be used when writing to this column
typeJSONRequired within parentThe type of the column
type (anyOf 1)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / type: boolean
type (anyOf 2)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: custom reference
type (anyOf 3)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / display_type: date, type: datetime
type (anyOf 4)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: native reference
type (anyOf 5)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / display_type: currency, number, percentage, type: number
type (anyOf 6)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / display_type: email, numeric id, paragraph, phone, plain text, url, type: text

Referenced models: List Custom Table columns — response body — data / item / type / type: boolean, List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: custom reference, List Custom Table columns — response body — data / item / type / display_type: date, type: datetime, List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: native reference, List Custom Table columns — response body — data / item / type / display_type: currency, number, percentage, type: number, List Custom Table columns — response body — data / item / type / display_type: email, numeric id, paragraph, phone, plain text, url, type: text

List Custom Table columns — response body — data / item / type / type: boolean
FieldTypePresenceDescription and constraints
$objectRoot
typestringRequired within parentKnown values: boolean
Default: boolean
List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: custom reference
FieldTypePresenceDescription and constraints
$objectRoot
cardinalitystringRequired within parentThe cardinality of the referencing column
Known values: many_to_many, many_to_one, one_to_many, one_to_one
corresponding_column_idJSONRequired within parent
corresponding_column_id (anyOf 1)stringAlternativeThe column in the referenced table that corresponds to the referencing column. This is null for forward-only reference columns.
Default: null
corresponding_column_id (anyOf 2)nullAlternative
table_display_namestringRequired within parentThe display name of the referenced table
table_idstringRequired within parentThe unique identifier for the referenced table
table_namestringRequired within parentThe API name of the custom table that is referenced
typestringRequired within parentKnown values: custom_reference
Default: custom_reference
List Custom Table columns — response body — data / item / type / display_type: date, type: datetime
FieldTypePresenceDescription and constraints
$objectRoot
display_typestringRequired within parentKnown values: date
typestringRequired within parentKnown values: datetime
Default: datetime
List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: native reference
FieldTypePresenceDescription and constraints
$objectRoot
cardinalitystringRequired within parentThe cardinality of the referencing column
Known values: many_to_many, many_to_one, one_to_many, one_to_one
corresponding_column_idJSONRequired within parent
corresponding_column_id (anyOf 1)stringAlternativeThe column in the referenced table that corresponds to the referencing column. This is null for forward-only reference columns.
Default: null
corresponding_column_id (anyOf 2)nullAlternative
table_idstringRequired within parentThe unique identifier for the referenced table
table_namestringRequired within parentThe native Ramp table that is referenced
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
tracking_categoryJSONRequired within parent
tracking_category (anyOf 1)ModelAlternativeExpand List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: native reference tracking category accounting provider is connected, display name, id, is active, uuid
Metadata about the tracking category when referencing accounting_field_options
Default: null
tracking_category (anyOf 2)nullAlternative
typestringRequired within parentKnown values: native_reference
Default: native_reference

Referenced models: List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: native reference tracking category accounting provider is connected, display name, id, is active, uuid

List Custom Table columns — response body — data / item / type / display_type: currency, number, percentage, type: number
FieldTypePresenceDescription and constraints
$objectRoot
display_typestringRequired within parentKnown values: currency, number, percentage
typestringRequired within parentKnown values: number
Default: number
List Custom Table columns — response body — data / item / type / display_type: email, numeric id, paragraph, phone, plain text, url, type: text
FieldTypePresenceDescription and constraints
$objectRoot
display_typestringRequired within parentKnown values: email, numeric_id, paragraph, phone, plain_text, url
typestringRequired within parentKnown values: text
Default: text
List Custom Table columns — response body — data / item / type / cardinality: many to many, many to one, one to many, one to one, type: native reference tracking category accounting provider is connected, display name, id, is active, uuid
FieldTypePresenceDescription and constraints
$objectRoot
accounting_provider_is_connectedbooleanRequired within parentWhether the tracking category's accounting provider is currently connected
display_nameJSONRequired within parent
display_name (anyOf 1)stringAlternativeThe display name of the tracking category
Default: null
display_name (anyOf 2)nullAlternative
idJSONRequired within parent
id (anyOf 1)integerAlternativeThe tracking category integer ID
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
is_activebooleanRequired within parentWhether the tracking category is active
uuidstringRequired within parentThe tracking category UUID (ramp_id)

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