Ramp: List vendors — vendor get Vendor List Resource

← vendor operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation ramp.get_vendor_list_resource

Provider route: GET /developer/v1/vendors. Alter supplies the connection’s credentials and routing.

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["vendor"]["getVendorListResource"]>[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.vendor.getVendorListResource(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.vendor.get_vendor_list_resource(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.external_vendor_id	string	Optional
query.merchant_id	string	Optional	Format: uuid
query.accounting_vendor_remote_ids	array	Optional
query.accounting_vendor_remote_ids[]	string	Each item
query.vendor_tracking_category_option_ids	array	Optional
query.vendor_tracking_category_option_ids[]	string	Each item	Format: uuid
query.sk_category_ids	JSON	Optional
query.sk_category_ids (anyOf 1)	array	Alternative
query.sk_category_ids (anyOf 1)[]	integer	Each item	One of: 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 2, 20, 21, 23, 24, 25, 26, 27, 28, 29, 3, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 4, 40, 41, 42, 43, 44, 5, 6, 7, 8, 9
query.sk_category_ids (anyOf 2)	null	Alternative
query.from_created_at	string	Optional	Format: date-time
query.to_created_at	string	Optional	Format: date-time
query.from_updated_at	string	Optional	Format: date-time
query.to_updated_at	string	Optional	Format: date-time
query.start	string	Optional
query.page_size	integer	Optional	Default: 20
query.vendor_owner_id	string	Optional	Format: uuid
query.include_subsidiary	boolean	Optional	Default: false
query.include_draft	boolean	Optional	Default: false
query.is_active	boolean	Optional
query.name	string	Optional

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 child vendors of a parent vendor — response body

Referenced models: List child vendors of a parent vendor — response body

Policy, approvals and errors

SDK function policy ID: ramp.get_vendor_list_resource. Catalog operation: get_vendor_list_resource. 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: ["vendors:read"]

Official provider source