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.
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"]["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 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.get_dev_api_native_table_column(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.native_table_name | string | Required within parent |
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 Custom Table columns — response body |
Referenced models: List Custom Table columns — response body
Schemas
Section titled “Schemas”List Custom Table columns — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
data | array | Required within parent | Resources returned in this page. |
data[] | Model | Each item | Expand List Custom Table columns — response body — data item |
page | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Pagination details for a Developer API response. |
next | JSON | Required within parent | |
next (anyOf 1) | string | Alternative | the query to get to the next page; it is in the format of <BASE_URL>?<new_params> |
next (anyOf 2) | null | Alternative |
List Custom Table columns — response body — data item
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cardinality | string | Required within parent | The cardinality of the referencing column Known values: many_to_many, many_to_one, one_to_many, one_to_one |
corresponding_column_id | JSON | Required within parent | |
corresponding_column_id (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
table_display_name | string | Required within parent | The display name of the referenced table |
table_id | string | Required within parent | The unique identifier for the referenced table |
table_name | string | Required within parent | The API name of the custom table that is referenced |
type | string | Required within parent | Known values: custom_reference Default: custom_reference |
List Custom Table columns — response body — data / item / type / display_type: date, type: datetime
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_type | string | Required within parent | Known values: date |
type | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cardinality | string | Required within parent | The cardinality of the referencing column Known values: many_to_many, many_to_one, one_to_many, one_to_one |
corresponding_column_id | JSON | Required within parent | |
corresponding_column_id (anyOf 1) | string | Alternative | The 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) | null | Alternative | |
table_id | string | Required within parent | The unique identifier for the referenced table |
table_name | string | Required within parent | The 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_category | JSON | Required within parent | |
tracking_category (anyOf 1) | Model | Alternative | Expand 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) | null | Alternative | |
type | string | Required within parent | Known values: native_reference Default: native_reference |
List Custom Table columns — response body — data / item / type / display_type: currency, number, percentage, type: number
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_type | string | Required within parent | Known values: currency, number, percentage |
type | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_type | string | Required within parent | Known values: email, numeric_id, paragraph, phone, plain_text, url |
type | string | Required within parent | Known 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
accounting_provider_is_connected | boolean | Required within parent | Whether the tracking category's accounting provider is currently connected |
display_name | JSON | Required within parent | |
display_name (anyOf 1) | string | Alternative | The display name of the tracking category Default: null |
display_name (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (anyOf 1) | integer | Alternative | The tracking category integer ID |
id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
is_active | boolean | Required within parent | Whether the tracking category is active |
uuid | string | Required within parent | The tracking category UUID (ramp_id) |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]