Ramp Developer API

https://docs.ramp.com/developer-api/v1/
Admin
The Ramp Developer API provides a RESTful interface for programmatic access to Ramp's financial and...
Tokens:194,447
Snippets:1,679
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Pagination Implementation with cURL

Source: https://docs.ramp.com/developer-api/v1/pagination

Example showing the initial request and the subsequent request using the 'next' URL and 'start' parameter.

```bash
# First request
curl "https://api.ramp.com/developer/v1/transactions?page_size=100" \
  -H "Authorization: Bearer $RAMP_API_TOKEN"


# Use the 'next' URL from the response for subsequent pages
curl "https://api.ramp.com/developer/v1/transactions?page_size=100&start=abc123..." \
  -H "Authorization: Bearer $RAMP_API_TOKEN"
```

--------------------------------

### Install the Ramp CLI

Source: https://docs.ramp.com/developer-api/v1/cli

Methods for installing the CLI tool using a shell script or the uv package manager.

```shell
curl -fsSL https://agents.ramp.com/install.sh | sh
```

```shell
uv tool install git+https://github.com/ramp-public/ramp-cli.git
```

--------------------------------

### Install and authenticate the Ramp CLI

Source: https://docs.ramp.com/developer-api/v1/build-for-ai-agents

Use these commands to install the Ramp CLI and authenticate your session for agent access.

```shell
curl -fsSL https://agents.ramp.com/install.sh | sh
ramp auth login
```

--------------------------------

### GET /v1/public/ramp-rate/vendors/compare

Source: https://docs.ramp.com/developer-api/v1/ramp-rate

Compares adoption metrics for multiple vendors.

```APIDOC
## GET /v1/public/ramp-rate/vendors/compare

### Description
Compare adoption metrics side by side for 2-10 vendors.

### Method
GET

### Endpoint
/v1/public/ramp-rate/vendors/compare
```

--------------------------------

### GET /vendors/compare

Source: https://docs.ramp.com/developer-api/v1/ramp-rate

Compare adoption metrics across 2-10 vendors.

```APIDOC
## GET /vendors/compare

### Description
Compare adoption metrics across 2-10 vendors.

### Method
GET

### Endpoint
https://api.ramp.com/v1/public/ramp-rate/vendors/compare

### Parameters
#### Query Parameters
- **vendor_slugs** (string) - Required - The vendor slugs to compare (repeatable for 2-10 vendors).
```

--------------------------------

### GET /categories

Source: https://docs.ramp.com/developer-api/v1/ramp-rate

List all available Ramp Rate software categories.

```APIDOC
## GET /categories

### Description
List all Ramp Rate software categories.

### Method
GET

### Endpoint
https://api.ramp.com/v1/public/ramp-rate/categories
```

--------------------------------

### GET /developer/v1/spend-programs

Source: https://docs.ramp.com/developer-api/v1/api/spend-programs

Lists spend programs with support for pagination.

```APIDOC
## GET /developer/v1/spend-programs

### Description
Retrieves a list of spend programs.

### Method
GET

### Endpoint
/developer/v1/spend-programs

### Parameters
#### Query Parameters
- **page_size** (integer) - Optional - The number of results to be returned in each page. The value must be between 2 and 100. Default is 20.
- **start** (string) - Optional - The ID of the last entity of the previous page, used for pagination.
```

--------------------------------

### Set up development environment

Source: https://docs.ramp.com/developer-api/v1/cli

Clone the repository and use uv to manage dependencies, pre-commit hooks, and test execution.

```Shell
git clone https://github.com/ramp-public/ramp-cli.git
cd ramp-cli
uv sync
uv run pre-commit install --install-hooks
uv run pre-commit run --all-files
uv run pytest tests/ -v
```

--------------------------------

### GET /categories/{category}/summary

Source: https://docs.ramp.com/developer-api/v1/ramp-rate

Get adoption statistics for a specific software category.

```APIDOC
## GET /categories/{category}/summary

### Description
Get adoption stats for a single category.

### Method
GET

### Endpoint
https://api.ramp.com/v1/public/ramp-rate/categories/{category}/summary

### Parameters
#### Path Parameters
- **category** (string) - Required - The name of the software category.
```

--------------------------------

### Execute Quick Start Commands

Source: https://docs.ramp.com/developer-api/v1/cli

Common commands for authentication and retrieving user, bill, and transaction data.

```shell
ramp auth login                              # Authenticate via browser
ramp users me                                # View your user details
ramp bills search --query "Acme"             # Search bills by vendor name
ramp transactions list --transactions_to_retrieve my_transactions
ramp transactions list --transactions_to_retrieve my_transactions --from_date 2025-01-01
```

--------------------------------

### GET /categories/{category}/vendors

Source: https://docs.ramp.com/developer-api/v1/ramp-rate

Get a ranked vendor leaderboard within a specific category.

```APIDOC
## GET /categories/{category}/vendors

### Description
Get a ranked vendor leaderboard within a category.

### Method
GET

### Endpoint
https://api.ramp.com/v1/public/ramp-rate/categories/{category}/vendors

### Parameters
#### Path Parameters
- **category** (string) - Required - The name of the software category.

#### Query Parameters
- **limit** (integer) - Optional - Maximum number of vendors to return (1-200, default 50).
- **fte_segment** (string) - Optional - Filter by company size segment.
- **min_share_of_spend** (number) - Optional - Filter out vendors below a spend share threshold.
```

--------------------------------

### List documentation directories

Source: https://docs.ramp.com/developer-api/v1/developer-mcp

Examples of paths for browsing the documentation virtual filesystem.

```text
/
/guides
/guides/ramp-rate
/openapi
```

--------------------------------

### GET /vendors/{vendor_slug}/profile

Source: https://docs.ramp.com/developer-api/v1/ramp-rate

Get a vendor's Ramp Rate profile across all of its categories.

```APIDOC
## GET /vendors/{vendor_slug}/profile

### Description
Get a vendor's Ramp Rate profile across all of its categories.

### Method
GET

### Endpoint
https://api.ramp.com/v1/public/ramp-rate/vendors/{vendor_slug}/profile

### Parameters
#### Path Parameters
- **vendor_slug** (string) - Required - The canonical slug of the vendor.
```

--------------------------------

### Configure CLI Output Modes

Source: https://docs.ramp.com/developer-api/v1/cli

Examples of switching between human-readable tables and machine-readable JSON output for scripts.

```shell
# Table output in your terminal
ramp transactions list --transactions_to_retrieve my_transactions


# Structured JSON for scripts and AI agents
ramp users me --agent | jq '.data[0].users[0].id'


# Pipe bill search results through jq
ramp bills search --query "Acme" --agent | jq '.data[0].bills[] | {id, amount, vendor_name}'
```

--------------------------------

### Read documentation files

Source: https://docs.ramp.com/developer-api/v1/developer-mcp

Examples of virtual paths used to read exported documentation files.

```text
/guides/webhooks.txt
/api/reference.txt
/openapi/developer-api.json
```

--------------------------------

### Accounting fields response example

Source: https://docs.ramp.com/developer-api/v1/customized-approvers

Example JSON response showing the structure of accounting fields including the ramp_id.

```json
{
  "data": [
    {
      "ramp_id": "7e2aef55-237f-47c8-8439-df6fd2842bab",
      "name": "Project Type",
      "id": "PROJECT_TYPE"
    }
  ]
}
```

--------------------------------

### GET /developer/v1/transactions

Source: https://docs.ramp.com/developer-api/v1/api/transactions

Retrieves a list of transactions.

```APIDOC
## GET /developer/v1/transactions

### Description
Retrieves a list of transactions.

### Method
GET

### Endpoint
/developer/v1/transactions

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### Access Ramp Rate API with cURL

Source: https://docs.ramp.com/developer-api/v1/ramp-rate

Examples for browsing categories, retrieving leaderboards, resolving vendor names, and comparing vendor metrics using the command line.

```shell
set -o pipefail


# 1. Browse categories
curl -fsS -H "Authorization: Bearer $RAMP_DATA_API_KEY" \
  https://api.ramp.com/v1/public/ramp-rate/categories | jq '.categories[].software_category'


# 2. Pick a category and see the leaderboard
curl -fsS -H "Authorization: Bearer $RAMP_DATA_API_KEY" \
  "https://api.ramp.com/v1/public/ramp-rate/categories/Observability/vendors?limit=5" | jq


# 3. Look up a specific vendor
curl -fsS -H "Authorization: Bearer $RAMP_DATA_API_KEY" \
  "https://api.ramp.com/v1/public/ramp-rate/vendors/resolve?vendor_name=Datadog" | jq


# 4. Get the vendor's full profile
curl -fsS -H "Authorization: Bearer $RAMP_DATA_API_KEY" \
  https://api.ramp.com/v1/public/ramp-rate/vendors/datadog/profile | jq


# 5. Compare two vendors head-to-head
curl -fsS -H "Authorization: Bearer $RAMP_DATA_API_KEY" \
  "https://api.ramp.com/v1/public/ramp-rate/vendors/compare?vendor_slugs=datadog&vendor_slugs=newrelic.com" | jq
```

--------------------------------

### GET /developer/v1/vendors/credits

Source: https://docs.ramp.com/developer-api/v1/api/vendors

Retrieves a list of vendor credits.

```APIDOC
## GET /developer/v1/vendors/credits

### Description
Retrieves a list of vendor credits.

### Method
GET

### Endpoint
/developer/v1/vendors/credits

### Response
#### Success Response (200)
- **data** (array) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### Configure Claude Desktop for Developer MCP

Source: https://docs.ramp.com/developer-api/v1/developer-mcp

Add the server configuration to the Claude Desktop settings file.

```json
{
  "mcpServers": {
    "ramp-developer": {
      "command": "npx",
      "args": ["mcp-remote", "https://mcp.ramp.com/developer/mcp"]
    }
  }
}
```

--------------------------------

### GET /developer/v1/bills/drafts

Source: https://docs.ramp.com/developer-api/v1/api/bills

Retrieves a list of draft bills.

```APIDOC
## GET /developer/v1/bills/drafts

### Description
Retrieves a list of draft bills.

### Method
GET

### Endpoint
/developer/v1/bills/drafts

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### GET /developer/v1/purchase-orders

Source: https://docs.ramp.com/developer-api/v1/api/purchase-orders

Retrieves a list of purchase orders.

```APIDOC
## GET /developer/v1/purchase-orders

### Description
Retrieves a list of purchase orders.

### Method
GET

### Endpoint
/developer/v1/purchase-orders

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### Initialize Ramp API Client with Vault Support

Source: https://docs.ramp.com/developer-api/v1/virtual-cards

Create a client class that handles authentication and switches between standard and Vault API base URLs.

```python
import base64
import logging
import os
import requests
from dotenv import load_dotenv


RAMP_API_HOST = 'demo-api.ramp.com'
RAMP_VAULT_API_HOST = 'demo-vault-api.ramp.com'
load_dotenv()


logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(levelname)s - %(message)s")
logger = logging.getLogger()


class RampApiClient:
    def __init__(self, client_id: str, client_secret: str):
        self.base_url = f"https://{RAMP_API_HOST}/"
        self.base_vault_url = f"https://{RAMP_VAULT_API_HOST}/"
        self.auth_secret = base64.b64encode(f"{client_id}:{client_secret}".encode()).decode()
        self._load_access_token()
        self.session = requests.session()
        self.session.headers = {
            "Accept": "application/json",
            "Authorization": f"Bearer {self.access_token}",
        }


    def _load_access_token(self):
        response = requests.post(
            f"{self.base_url}developer/v1/token",
            headers={
                "Accept": "application/json",
                "Authorization": f"Basic {self.auth_secret}",
                "Content-Type": "application/x-www-form-urlencoded",
            },
            data={
                "grant_type": "client_credentials",
                "scope": "cards:read_vault limits:write funds:write users:read",
            },
        )
        response.raise_for_status()
        self.access_token = response.json()["access_token"]


    def request(self, method: str, path: str, **kwargs) -> dict:
        base_url = self.base_url if not kwargs.pop("use_vault", False) else self.base_vault_url
        response = self.session.request(method, base_url + path, **kwargs)
        response.raise_for_status()
        return response.json() if response.text else None


CLIENT = RampApiClient(client_id=os.environ["RAMP_CLIENT_ID"], client_secret=os.environ["RAMP_CLIENT_SECRET"])
```

--------------------------------

### Iframe handshake process

Source: https://docs.ramp.com/developer-api/v1/virtual-cards

Steps to initialize the Ramp-hosted iframe by fetching an embed token and posting it to the iframe via postMessage.

```text
1. Render an empty iframe in your page.
2. Fetch /your-backend/embed-token (returns embed_init_token).
3. Set iframe.src to the business-specific URL for your environment:
   Sandbox: "https://demo-embed.ramp.com/business/{business_id}"
   Production: "https://embed.ramp.com/business/{business_id}"
4. On iframe load, postMessage to it:
       { type: "ramp.embed.init", token: embed_init_token }
   targetOrigin must match the iframe origin exactly.
```

--------------------------------

### GET /developer/v1/reimbursements

Source: https://docs.ramp.com/developer-api/v1/api/reimbursements

Retrieves a list of reimbursement resources.

```APIDOC
## GET /developer/v1/reimbursements

### Description
Retrieves a list of reimbursement resources.

### Method
GET

### Endpoint
/developer/v1/reimbursements

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### GET /vendors/credits

Source: https://docs.ramp.com/developer-api/v1/accounting-erp-migration

Retrieves a list of vendor credits.

```APIDOC
## GET /vendors/credits

### Description
Fetches a list of vendor credits.

### Method
GET

### Endpoint
/vendors/credits

### Response
#### Success Response (200)
- **data** (array) - List of vendor credit objects.
```

--------------------------------

### Upload a document for a blank canvas workflow step

Source: https://docs.ramp.com/developer-api/v1/api/blank-canvas-approvals

Upload supporting documentation for an approval request using multipart/form-data.

```Shell
curl \
  -X POST \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $RAMP_API_TOKEN" \
    'https://api.ramp.com/developer/v1/blank-canvas-approvals/documents'
```

--------------------------------

### GET /developer/v1/accounting/vendors

Source: https://docs.ramp.com/developer-api/v1/api/accounting-vendors

Retrieves a list of accounting vendors.

```APIDOC
## GET /developer/v1/accounting/vendors

### Description
Retrieves a list of accounting vendors.

### Method
GET

### Endpoint
/developer/v1/accounting/vendors

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### Configure CLI Environments

Source: https://docs.ramp.com/developer-api/v1/cli

Commands to switch between production and sandbox environments, either globally or per-command.

```shell
ramp env production              # Set default to production
ramp env sandbox                 # Set default back to sandbox
ramp users me --env production  # Override per-command
```

--------------------------------

### Create a matrix table

Source: https://docs.ramp.com/developer-api/v1/customized-approvers

Send a POST request to create a matrix table that maps accounting field options to users.

```bash
curl -X POST "https://api.ramp.com/developer/v1/custom-records/matrix-tables" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "project_approver",
    "label": "Project Approver",
    "input_columns": [
      {
        "name": "project",
        "label": "Project",
        "column_type": {
          "type": "native_table",
          "table_name": "accounting_field_options",
          "accounting_field_ramp_id": "7e2aef55-237f-47c8-8439-df6fd2842bab"
        }
      }
    ],
    "result_columns": [
      {
        "name": "approver",
        "label": "Approver",
        "cardinality": "many_to_many",
        "native_table": {
          "type": "native_table",
          "table_name": "users"
        }
      }
    ]
  }'
```

--------------------------------

### GET /webhooks

Source: https://docs.ramp.com/developer-api/v1/webhooks

List all webhook subscriptions associated with the account.

```APIDOC
## GET /webhooks

### Description
List all webhook subscriptions.

### Method
GET

### Endpoint
https://api.ramp.com/developer/v1/webhooks
```

--------------------------------

### Fetch a financing application

Source: https://docs.ramp.com/developer-api/v1/api/applications

Retrieves the active financing application for a business using a GET request.

```shell
curl \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $RAMP_API_TOKEN" \
    'https://api.ramp.com/developer/v1/applications'
```

--------------------------------

### Manage AI Agent Skills

Source: https://docs.ramp.com/developer-api/v1/cli

Commands to list, inspect, and install skills for AI agent frameworks.

```shell
# List available skills
ramp skills list


# View details for a specific skill
ramp skills show <skill-name>


# Install a skill into your agent's skill directory
ramp skills install <skill-name>
```

--------------------------------

### GET /v1/public/ramp-rate/categories

Source: https://docs.ramp.com/developer-api/v1/ramp-rate

Retrieves a list of all available software categories.

```APIDOC
## GET /v1/public/ramp-rate/categories

### Description
List all software categories available in the Ramp Rate system.

### Method
GET

### Endpoint
/v1/public/ramp-rate/categories
```

--------------------------------

### Select an operation for developer_docs_schema

Source: https://docs.ramp.com/developer-api/v1/developer-mcp

Examples of valid selectors for retrieving an OpenAPI operation object.

```text
operation_id
input
method + path
```

```text
operation_id: post_token
input: POST /developer/v1/token
method: DELETE
path: /developer/v1/bills/{bill_id}
```

--------------------------------

### GET /vendors/resolve

Source: https://docs.ramp.com/developer-api/v1/ramp-rate

Resolve a vendor name to its canonical vendor_slug.

```APIDOC
## GET /vendors/resolve

### Description
Resolve a vendor name to its canonical vendor_slug.

### Method
GET

### Endpoint
https://api.ramp.com/v1/public/ramp-rate/vendors/resolve

### Parameters
#### Query Parameters
- **vendor_name** (string) - Required - The name of the vendor to resolve.
```

--------------------------------

### GET /developer/v1/vendors

Source: https://docs.ramp.com/developer-api/v1/bill-pay

Retrieves a list of all vendors associated with the business.

```APIDOC
## GET /developer/v1/vendors

### Description
List all vendors associated with the business.

### Method
GET

### Endpoint
/developer/v1/vendors
```

--------------------------------

### POST /developer/v1/users/invite

Source: https://docs.ramp.com/developer-api/v1/api/users

Triggers an async task to send a user invite via email for onboarding.

```APIDOC
## POST /developer/v1/users/invite

### Description
Call this endpoint to trigger an async task to send out a user invite via email. Users will need to accept the invite in order to be onboarded.

### Method
POST

### Endpoint
/developer/v1/users/invite

### Parameters
#### Request Body
- **email** (string<email>) - Required - The employee's email address.
- **first_name** (string) - Required - First name of the employee (<= 255 characters).
- **idempotency_key** (string) - Required - A unique value generated by the client to recognize retries.
- **last_name** (string) - Required - Last name of the employee (<= 255 characters).
- **role** (string) - Required - The employee's role (Admin, Cardholder, Bookkeeper).
- **department_id** (string<uuid>) - Optional - Unique identifier of the employee's department.
- **direct_manager_id** (string<uuid>) - Optional - Unique identifier of the employee's direct manager.
- **is_draft** (boolean) - Optional - When true, the user is created as a draft and no email is sent.
- **is_manager** (boolean) - Optional - Whether the employee is a manager.
- **location_id** (string<uuid>) - Optional - Unique identifier of the employee's location.
- **scheduled_deactivation_date** (string<date>) - Optional - The date when the user is scheduled to be deactivated.
```

--------------------------------

### GET /developer/v1/bills

Source: https://docs.ramp.com/developer-api/v1/api/bills

Retrieves a list of bills associated with the account.

```APIDOC
## GET /developer/v1/bills

### Description
Retrieves a list of bills.

### Method
GET

### Endpoint
/developer/v1/bills

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### GET /developer/v1/funds

Source: https://docs.ramp.com/developer-api/v1/api/funds

Retrieves a list of all funds associated with the account.

```APIDOC
## GET /developer/v1/funds

### Description
Retrieves a list of all funds associated with the account.

### Method
GET

### Endpoint
/developer/v1/funds

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### Example API Response for User Data

Source: https://docs.ramp.com/developer-api/v1/custom-records

A sample JSON response showing user details, including bidirectional references to custom tables.

```json
{
  "data": [{
    "id": "<uuid>",
    "external_key": "01956422-6793-7700-adb4-3f1bd635ee49",
    "display_name": "John Doe",
    "cells": [
      {
        "column_id": "<uuid>",
        "column_display_name": "Home State",
        "value": {
          "table_name": "states",
          "type": "custom_table",
          "rows": [
            {
              "row_id": "<uuid>",
              "external_key": "California",
              "display_name": "California",
              "type": "custom_table"
            }
          ],
          "has_more": false
        }
      },
      {
        "column_id": "<uuid>",
        "column_display_name": "Regional Director For",
        "value": {
          "table_name": "regions",
          "type": "custom_table",
          "rows": [
            {
              "row_id": "<uuid>",
              "external_key": "West",
              "display_name": "West",
              "type": "custom_table"
            },
            {
              "row_id": "<uuid>",
              "external_key": "Northwest",
              "display_name": "Northwest",
              "type": "custom_table"
            }
          ],
          "has_more": false
        }
      }
    ]
  }],
  "page": {
    "next": null
  }
}
```

--------------------------------

### Configure Environment Variables

Source: https://docs.ramp.com/developer-api/v1/virtual-cards

Store your Ramp API credentials in a .env file for secure access.

```text
RAMP_CLIENT_ID=foo
RAMP_CLIENT_SECRET=bar
```

--------------------------------

### GET /developer/v1/users

Source: https://docs.ramp.com/developer-api/v1/api/users

Retrieves a list of users associated with the account.

```APIDOC
## GET /developer/v1/users

### Description
Retrieves a list of users.

### Method
GET

### Endpoint
/developer/v1/users

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### Create a deferred user via POST

Source: https://docs.ramp.com/developer-api/v1/api/users

Initiates a deferred user creation request. Requires the users:write scope.

```Shell
curl \
  -X POST \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $RAMP_API_TOKEN" \
  -d '{
  "department_id": "2d68eb67-f6eb-4284-8683-7d530c77a5a6",
  "direct_manager_id": "ccc5d4cc-337f-49a5-86b3-5df128233f2c",
  "email": "cardholder_7@company.com",
  "first_name": "Linda",
  "idempotency_key": "d471d830-2e73-4082-8a75-68540f83e86e",
  "is_manager": false,
  "last_name": "Gu",
  "location_id": "f4efe11c-221f-4b49-a1e4-33eaf96a49ee",
  "role": "BUSINESS_USER"
}' \
    'https://api.ramp.com/developer/v1/users/deferred'
```

--------------------------------

### GET /bills

Source: https://docs.ramp.com/developer-api/v1/accounting-erp-migration

Fetch bills that are ready to be synced to an ERP.

```APIDOC
## GET /bills

### Description
Retrieves a list of bills that are ready to sync.

### Method
GET

### Endpoint
/bills?sync_ready=true

### Query Parameters
- **sync_ready** (boolean) - Required - Filter for bills ready to sync.
```

--------------------------------

### GET /cashbacks

Source: https://docs.ramp.com/developer-api/v1/accounting-erp-migration

Fetch cashbacks that are ready to be synced to an ERP.

```APIDOC
## GET /cashbacks

### Description
Retrieves a list of cashbacks with a status of SYNC_READY.

### Method
GET

### Endpoint
/cashbacks?sync_status=SYNC_READY

### Query Parameters
- **sync_status** (string) - Required - Filter for cashbacks ready to sync.
```

--------------------------------

### POST /developer/v1/ai-usage/unified

Source: https://docs.ramp.com/developer-api/v1/ai-usage

Sends a batch of AI usage events for a specific customer to Ramp for ingestion into their spend analytics.

```APIDOC
## POST /developer/v1/ai-usage/unified

### Description
Sends a batch of AI usage events to Ramp. Each request is a batch envelope containing one or more events for a single customer.

### Method
POST

### Endpoint
https://api.ramp.com/developer/v1/ai-usage/unified

### Request Body
- **schema_version** (string) - Required - Unified schema version. Must be "1.0".
- **events** (array) - Required - AI usage events. Each item represents one model call.

### Request Example
{
  "schema_version": "1.0",
  "events": [
    {
      "event_id": "evt_01J4W7A9ZP9J1K8QK6F3H2M5N0",
      "source": "ai-platform",
      "occurred_at": "2026-07-01T20:15:30+00:00",
      "provider": "model-provider",
      "model": "provider-model-name",
      "usage": {
        "input_tokens": 1200,
        "output_tokens": 240,
        "cache_read_input_tokens": 600,
        "cache_write_input_tokens": 0,
        "reasoning_output_tokens": 0,
        "meters": []
      },
      "pricing_context": {
        "service_tier": "standard",
        "fast_mode": false,
        "session_created_at": "2026-07-01T20:00:00+00:00",
        "long_context": false,
        "inference_geo": "us"
      },
      "reported_cost": {
        "amount": "0.0124",
        "currency": "USD",
        "provenance": "platform",
        "estimated": true
      },
      "provider_latency_seconds": 1.42,
      "attribution": {
        "session_id": "session_abc",
        "turn_id": "turn_001",
        "user_id": "user_12345",
        "tags": {
          "team": "support",
          "project": "ticket-triage",
          "environment": "production",
          "cost_center": "CC-1234"
        }
      }
    }
  ]
}

### Response
#### Success Response (204)
- No Content - The batch was accepted for asynchronous ingestion.
```

--------------------------------

### GET /transfers

Source: https://docs.ramp.com/developer-api/v1/accounting-erp-migration

Fetch transfers that are ready to be synced to an ERP.

```APIDOC
## GET /transfers

### Description
Retrieves a list of transfers with a status of SYNC_READY.

### Method
GET

### Endpoint
/transfers?sync_status=SYNC_READY

### Query Parameters
- **sync_status** (string) - Required - Filter for transfers ready to sync.
```

--------------------------------

### Sample X-Ramp-Signature header

Source: https://docs.ramp.com/developer-api/v1/webhooks

An example of the header format sent by Ramp in webhook requests.

```text
X-Ramp-Signature: 7f2a8b9c3d4e5f6a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e
```

--------------------------------

### GET /reimbursements

Source: https://docs.ramp.com/developer-api/v1/accounting-erp-migration

Fetch reimbursements that are ready to be synced to an ERP.

```APIDOC
## GET /reimbursements

### Description
Retrieves a list of reimbursements with a status of SYNC_READY.

### Method
GET

### Endpoint
/reimbursements?sync_status=SYNC_READY

### Query Parameters
- **sync_status** (string) - Required - Filter for reimbursements ready to sync.
```

--------------------------------

### Example AI Agent Commands

Source: https://docs.ramp.com/developer-api/v1/build-for-ai-agents

Common natural language tasks an AI agent can perform on the Ramp platform.

```text
"What's our software spend this quarter, by vendor?"
"Approve the reimbursements waiting on me, except anything over $1K"
"Submit my expense report — receipts are in /tmp/receipts"
"Lock the card ending 4321 — I lost it"
"Buy this SaaS license for the team — here's the pricing page"
```

--------------------------------

### GET /transactions

Source: https://docs.ramp.com/developer-api/v1/accounting-erp-migration

Fetch transactions that are ready to be synced to an ERP.

```APIDOC
## GET /transactions

### Description
Retrieves a list of transactions with a status of SYNC_READY.

### Method
GET

### Endpoint
/transactions?sync_status=SYNC_READY

### Query Parameters
- **sync_status** (string) - Required - Filter for transactions ready to sync.
```

--------------------------------

### Create Application via cURL

Source: https://docs.ramp.com/developer-api/v1/api/applications

Submit a new business application by sending a POST request with the required applicant, business, and financial details.

```shell
curl \
  -X POST \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $RAMP_API_TOKEN" \
  -d '{
  "applicant": {
    "email": "jane@acmeplumbing.com",
    "first_name": "Jane",
    "last_name": "Doe",
    "phone": "+14155550124"
  },
  "application_type": "RAMP_SUITE",
  "beneficial_owners": [
    {
      "address": {
        "city": "San Francisco",
        "country": "US",
        "postal_code": "94104",
        "state": "CA",
        "street_address": "200 Pine St"
      },
      "birth_date": "1982-11-04",
      "email": "john@acmeplumbing.com",
      "first_name": "John",
      "last_name": "Smith",
      "ownership_percentage": 40,
      "phone": "+14155550125",
      "ssn_last_4": "5678",
      "title": "Co-Founder"
    }
  ],
  "business": {
    "address": {
      "apt_suite": "Suite 500",
      "city": "San Francisco",
      "postal_code": "94105",
      "state": "CA",
      "street_address": "123 Market St"
    },
    "business_description": "Residential and commercial plumbing services",
    "business_name_dba": null,
    "business_name_legal": "Acme Plumbing LLC",
    "business_name_on_card": null,
    "business_website": "https://acmeplumbing.com",
    "incorporation": {
      "date_of_incorporation": "2018-06-15",
      "ein_number": "12-3456789",
      "entity_type": "LLC",
      "state_of_incorporation": "CA"
    },
    "phone": "+14155550123"
  },
  "controlling_officer": {
    "address": {
      "city": "San Francisco",
      "country": "US",
      "postal_code": "94105",
      "state": "CA",
      "street_address": "123 Market St"
    },
    "birth_date": "1985-03-12",
    "email": "jane@acmeplumbing.com",
    "first_name": "Jane",
    "is_beneficial_owner": true,
    "last_name": "Doe",
    "ownership_percentage": 60,
    "phone": "+14155550124",
    "ssn_last_4": "1234",
    "title": "Owner"
  },
  "financial_details": {
    "estimated_monthly_ap_spend_amount": 25000,
    "estimated_monthly_spend_amount": 50000
  },
  "lead_referral_partner_channel": "cli",
  "lead_referral_partner_code": "cofounder_co",
  "manual_bank_account": {
    "account_number": "12345",
    "account_subtype": "checking",
    "balance": "12345.00",
    "routing_number": "123456780"
  },
  "oauth_authorize_params": {
    "redirect_uri": "https://partner.example.com/oauth/callback",
    "state": "abc123"
  },
  "ownership_acknowledgement": "CONFIRM_ALL_MAJOR_OWNERS_ENTERED"
}' \
    'https://api.ramp.com/developer/v1/applications'
```

--------------------------------

### GET /developer/v1/custom-records/matrix-tables

Source: https://docs.ramp.com/developer-api/v1/api/custom-records-matrix-tables

Retrieves a list of all Matrix tables for the business.

```APIDOC
## GET /developer/v1/custom-records/matrix-tables

### Description
List all Matrix tables for the business.

### Method
GET

### Endpoint
/developer/v1/custom-records/matrix-tables

### Response
#### Success Response (200)
- **data** (array<object>) - List of Matrix tables
```

--------------------------------

### Configure Tax Codes via API

Source: https://docs.ramp.com/developer-api/v1/accounting-erp-migration

Follow the strict order of operations: create rates, define the tax field, and then set options referencing the rate IDs.

```curl
# Rates: rate value, name, and the GL account that books the tax
curl -X POST -d '{ "tax_rates": [
  { "id": "gst_5", "name": "GST", "rate": "0.05",
    "accounting_gl_account_id": "<gl_account_ramp_id>" }
]}' .../accounting/tax/rates


# Field: one per connection; skip if it already exists
curl -X POST -d '{ "name": "Tax Code", "display_name": "Tax Code" }' \
  .../accounting/tax/code


# Options: each references one or more rate IDs from step 4a
curl -X POST -d '{ "options": [
  { "id": "gst_only", "name": "GST Only", "tax_rate_ids": ["gst_5"] }
]}' .../accounting/tax/code/options
```

--------------------------------

### Verify connection creation response

Source: https://docs.ramp.com/developer-api/v1/erp-integrations

Example JSON response confirming the creation of an inactive accounting connection.

```json
{
  "id": "36a6e497-91eb-4167-ad5c-23b84f2ca84c",
  "is_active": false,
  "connection_type": "API",
  "remote_provider_name": "Your ERP",
  "status": "UNLINKED",
  "last_linked_at": null,
  "created_at": "2025-12-08T01:27:04+00:00"
}
```

--------------------------------

### GET /developer/v1/memos

Source: https://docs.ramp.com/developer-api/v1/api/memos

Lists memos with optional filtering capabilities.

```APIDOC
## GET /developer/v1/memos

### Description
Retrieves a list of memos, supporting various filters for cards, departments, dates, and users.

### Method
GET

### Endpoint
/developer/v1/memos

### Parameters
#### Query Parameters
- **card_id** (string<uuid>) - Optional - Filter memos by card.
- **department_id** (string<uuid>) - Optional - Filter memos by department.
- **from_date** (string<date-time>) - Optional - Filter memos for transactions after this date.
- **location_id** (string<uuid>) - Optional - Filter memos by location.
- **manager_id** (string<uuid>) - Optional - Filter memos by manager.
- **merchant_id** (string<uuid>) - Optional - Filter memos by merchant.
- **page_size** (integer) - Optional - Number of results per page (2-100).
- **start** (string) - Optional - ID of the last entity of the previous page for pagination.
- **to_date** (string<date-time>) - Optional - Filter memos for transactions before this date.
- **user_id** (string<uuid>) - Optional - Filter memos by user.

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details.
```

--------------------------------

### GET /developer/v1/locations

Source: https://docs.ramp.com/developer-api/v1/api/locations

Lists all business locations associated with the account.

```APIDOC
## GET /developer/v1/locations

### Description
Retrieves a list of business locations.

### Method
GET

### Endpoint
/developer/v1/locations

### Parameters
#### Query Parameters
- **entity_id** (string<uuid>) - Optional - Filter by associated business entity.
- **page_size** (integer) - Optional - The number of results to be returned in each page (2-100).
- **start** (string) - Optional - The ID of the last entity of the previous page, used for pagination.

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### Create a vendor agreement

Source: https://docs.ramp.com/developer-api/v1/api/vendors

Use this POST request to create a new vendor agreement. Ensure the Authorization header includes a valid Ramp API token.

```shell
curl \
  -X POST \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $RAMP_API_TOKEN" \
  -d '{
  "auto_renewal": true,
  "contract_owner_ids": [
    "2d68eb67-f6eb-4284-8683-7d530c77a5a6"
  ],
  "description": "Annual software agreement",
  "end_date": "2025-12-31",
  "last_date_to_terminate": "2025-11-30",
  "line_items": [
    {
      "price_per_unit": "1250",
      "product_or_service_name": "Platform subscription",
      "quantity": "1",
      "total_price": "1250"
    }
  ],
  "name": "MSA - Acme",
  "notifications_on": true,
  "start_date": "2025-01-01",
  "total_value": {
    "amount": 125000,
    "currency_code": "USD"
  }
}' \
    'https://api.ramp.com/developer/v1/vendors/VENDOR_ID/agreements'
```

--------------------------------

### GET /developer/v1/departments

Source: https://docs.ramp.com/developer-api/v1/api/departments

Retrieves a list of departments with pagination support.

```APIDOC
## GET /developer/v1/departments

### Description
Lists all departments associated with the account.

### Method
GET

### Endpoint
/developer/v1/departments

### Parameters
#### Query Parameters
- **page_size** (integer) - Optional - The number of results to be returned in each page (2-100).
- **start** (string) - Optional - The ID of the last entity of the previous page, used for pagination.

### Response
#### Success Response (200)
- **data** (array<object>) - Resources returned in this page.
- **page** (object) - Pagination details for a Developer API response.
```

--------------------------------

### Create a department

Source: https://docs.ramp.com/developer-api/v1/api/departments

Sends a POST request to create a new department with a specified name.

```Shell
curl \
  -X POST \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $RAMP_API_TOKEN" \
  -d '{
  "name": "Engineering"
}' \
    'https://api.ramp.com/developer/v1/departments'
```

--------------------------------

### POST /applications

Source: https://docs.ramp.com/developer-api/v1/api/applications

Creates a new financing application for a business, triggering an invitation email to the applicant to complete the sign-up process in the Ramp UI.

```APIDOC
## POST /applications

### Description
Creates a new business for the applicant and emails them instructions to sign up. If the applicant email exists, an invitation is re-sent; if the business is already approved, the operation is a no-op.

### Method
POST

### Endpoint
/applications

### Parameters
#### Request Body
- **applicant** (object) - Required - Information about the applicant.
- **application_type** (string) - Optional - Type of financing application to create.
- **beneficial_owners** (array<object>) - Optional - Beneficial owners of the business.
- **business** (object) - Optional - Business details.
- **controlling_officer** (object) - Optional - The controlling officer of the business.
- **financial_details** (object) - Optional - Financial details for underwriting.
- **lead_referral_partner_channel** (string) - Optional - Optional unverified agent harness that reported the lead_referral_partner_code.
- **lead_referral_partner_code** (string) - Optional - Optional unverified agent-reported Ramp partner code for lead attribution.
- **manual_bank_account** (object) - Optional - Manual bank account to add for underwriting.
- **oauth_authorize_params** (object) - Optional - OAuth authorization parameters for redirecting to a consent screen.
- **ownership_acknowledgement** (string) - Optional - Confirmation that all 25%+ beneficial owners have been supplied.
```
Tokens:
Raw