Ramp: List Custom Table rows
Ramp customRecords.getDevApiCustomRow: arguments, response, policy and SDK examples.
← Custom records operations · Get started
Operation ramp.get_dev_api_custom_row
Provider route: GET /developer/v1/custom-records/custom-tables/{custom_table_name}/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"]["getDevApiCustomRow"]>[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.getDevApiCustomRow(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_custom_row(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.custom_table_name | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.external_key | JSON | Optional | |
query.external_key (anyOf 1) | array | Alternative | External key of the custom row Default: null |
query.external_key (anyOf 1)[] | string | Each item | |
query.external_key (anyOf 2) | null | Alternative | |
query.include_all_referenced_rows | boolean | Optional | Include all referenced rows in each cell rather than a subset of them. Default: false |
query.page_size | integer | Optional | Number of rows to include in the response. Max: 100 Default: 50 |
query.start | JSON | Optional | |
query.start (anyOf 1) | string | Alternative | The value of the `next` field from the previous response, if any Default: null |
query.start (anyOf 2) | null | Alternative |
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 rows — response body |
Referenced models: List Custom Table rows — response body
Schemas
Section titled “Schemas”List Custom Table rows — 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 rows — 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 rows — 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 rows — response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
cells | array | Required within parent | The contents of each column for this row. |
cells[] | Model | Each item | Expand Get a business entity — response body — custom record fields item |
display_name | string | Required within parent | A display name for the custom row. |
external_key | string | Required within parent | The external key of the custom row. Will be unique within the table. |
id | string | Required within parent | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
column_display_name | string | Required within parent | The display name of the column |
column_id | string | Required within parent | The id of the column |
value | JSON | Required within parent | The 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) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type boolean |
value (anyOf 2) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type custom table |
value (anyOf 3) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type date |
value (anyOf 4) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type native table |
value (anyOf 5) | Model | Alternative | Expand Get a business entity — response body — custom record fields item value type number |
value (anyOf 6) | Model | Alternative | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | string | Required within parent | |
type | string | Required within parent | Must equal: boolean |
value | boolean | Required within parent |
Get a business entity — response body — custom record fields item value type date
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | string | Required within parent | |
type | string | Required within parent | Must equal: date |
value | string | Required within parent | Format: date-time |
Get a business entity — response body — custom record fields item value type custom table
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
has_more | boolean | Required within parent | Indicates if there are more rows in the table than are included in this response |
rows | array | Required within parent | The rows referenced by this cell |
rows[] | Model | Each item | Expand Get a business entity — response body — custom record fields item value type custom table rows item |
table_name | string | Required within parent | The custom table that referenced rows are part of |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
has_more | boolean | Required within parent | Indicates if there are more rows in the table than are included in this response |
rows | array | Required within parent | The rows referenced by this cell |
rows[] | Model | Each item | Expand Get a business entity — response body — custom record fields item value type native table rows item |
table_name | string | Required within parent | The 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 |
type | string | Required within parent | Must 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | string | Required within parent | |
type | string | Required within parent | Must equal: number |
value | JSON | Required within parent | |
value (anyOf 1) | number | Alternative | |
value (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Get a business entity — response body — custom record fields item value type text
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | string | Required within parent | |
type | string | Required within parent | Must equal: text |
value | string | Required within parent |
Get a business entity — response body — custom record fields item value type custom table rows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | string | Required within parent | |
external_key | string | Required within parent | The external key of the row |
row_id | string | Required within parent | The id of the row |
type | string | Required within parent | Known values: custom_table Default: custom_table |
Get a business entity — response body — custom record fields item value type native table rows item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
display_name | string | Required within parent | |
external_key | string | Required within parent | The id of the Ramp object |
type | string | Required within parent | Known values: native_table Default: native_table |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.get_dev_api_custom_row. Catalog operation: get_dev_api_custom_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"]