Skip to content

Ramp: List business entities

Ramp businessEntities.getEntityListWithPagination: arguments, response, policy and SDK examples.

← Business entities operations · Get started

Operation ramp.get_entity_list_with_pagination

Provider route: GET /developer/v1/entities. 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["businessEntities"]["getEntityListWithPagination"]>[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.businessEntities.getEntityListWithPagination(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.business_entities.get_entity_list_with_pagination(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.currencystringOptionalOne of: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL
query.entity_namestringOptional
query.is_primarybooleanOptional
query.hide_inactivebooleanOptionalDefault: false
query.include_custom_field_valuesbooleanOptionalDefault: false
query.startstringOptional
query.page_sizeintegerOptionalDefault: 20
query.include_deleted_accountsJSONOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand List business entities — response body

Referenced models: List business entities — response body

6 more schemas are linked from the tables above, on the schema pages.

List business entities — response body
FieldTypePresenceDescription and constraints
$objectRoot
dataarrayRequired within parentResources returned in this page.
data[]ModelEach itemExpand Get a business entity — response body
pageModelRequired within parentExpand List bills — response body — page
Pagination details for this response.

Referenced models: List bills — response body — page, Get a business entity — response body

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
Get a business entity — response body
FieldTypePresenceDescription and constraints
$objectRoot
accountsarrayRequired within parentInformation about the entity's active accounts
Read only: true
accounts[]ModelEach itemExpand Get a business entity — response body — accounts item
connected_subsidiaryJSONRequired within parent
connected_subsidiary (anyOf 1)ModelAlternativeExpand Get a business entity — response body — connected subsidiary external id, id, name
The subsidiary in the ERP system that this entity is mapped to. This determines which subsidiary transactions from this entity will be synced to.
Read only: true
connected_subsidiary (anyOf 2)nullAlternative
currencyJSONRequired within parent
currency (anyOf 1)stringAlternativeCurrency used by this business entity.
Known values: AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHE, CHF, CHW, CLF, CLP, CNH, CNY, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EURC, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, OPEN_USD, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLE, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USDB, USDC, USDG, USDT, USN, UYI, UYU, UYW, UZS, VED, VES, VND, VUV, WST, XAD, XAF, XAG, XAU, XBA, XBB, XBC, XBD, XCD, XCG, XDR, XOF, XPD, XPF, XPT, XSU, XTS, XUA, XXX, YER, ZAR, ZMW, ZWG, ZWL
currency (anyOf 2)nullAlternative
custom_record_fieldsarrayOptionalCustom record field values associated with this entity. Only returned when `include_custom_field_values=true`.
Read only: true
custom_record_fields[]ModelEach itemExpand Get a business entity — response body — custom record fields item
default_bill_pay_payment_account_idJSONRequired within parent
default_bill_pay_payment_account_id (anyOf 1)stringAlternativeBank account UUID of the entity's configured default Bill Pay payment account, if one exists. This UUID can be matched against payment_accounts[].id and accounts[].bank_account_id when those records are present.
Format: uuid
Read only: true
default_bill_pay_payment_account_id (anyOf 2)nullAlternative
entity_namestringRequired within parentName of the business entity.
idstringRequired within parentUnique identifier for the business entity.
Format: uuid
is_primaryJSONRequired within parent
is_primary (anyOf 1)booleanAlternativeWhether this is the primary entity for the business.
is_primary (anyOf 2)nullAlternative
location_idsarrayRequired within parentList of identifiers for locations associated with this entity.
Read only: true
location_ids[]stringEach itemFormat: uuid
payment_accountsarrayRequired within parentBank accounts eligible for bill payment for this entity.
Read only: true
payment_accounts[]ModelEach itemExpand Get a business entity — response body — payment accounts item

Referenced models: Get a business entity — response body — connected subsidiary external id, id, name, Get a business entity — response body — payment accounts item, Get a business entity — response body — custom record fields item, Get a business entity — response body — accounts item

Get a business entity — response body — connected subsidiary external id, id, name
FieldTypePresenceDescription and constraints
$objectRoot
external_idstringRequired within parentExternal ID of the subsidiary in the ERP system
idstringRequired within parentID that uniquely identifies the subsidiary within Ramp
namestringRequired within parentName of the subsidiary in the ERP system
Get a business entity — response body — payment accounts item
FieldTypePresenceDescription and constraints
$objectRoot
account_namestringRequired within parentDisplay name of the bank account
account_number_last_fourstringRequired within parentLast four digits of the account number
currencystringRequired within parentISO 4217 currency code of the bank account (e.g. USD, CAD)
idstringRequired within parentUnique identifier of the bank account.
Format: uuid
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 text
FieldTypePresenceDescription and constraints
$objectRoot
display_namestringRequired within parent
typestringRequired within parentMust equal: text
valuestringRequired within parent

SDK function policy ID: ramp.get_entity_list_with_pagination. Catalog operation: get_entity_list_with_pagination. 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: ["entities: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.