Skip to main content

API Overview

The Melio Partner API provides access to the user's data in Melio.

Getting Started​

Before making API calls, you'll need to authenticate using Bearer token authentication.

API Structure​

The API is organized around core business entities, each with dedicated endpoints:

  • Organizations - GET /v1/organizations
  • Bills - GET /v1/bills
  • Payments - GET /v1/payments
  • Vendors - GET /v1/vendors

All entity endpoints follow the get<Entities> naming convention and support filtering by:

  • organizationId - Filter by organization
  • ids - Retrieve specific entities by ID
  • Most endpoints require at least one filter parameter

Pagination​

The API uses cursor-based pagination for efficient data retrieval:

Request Parameters​

  • limit - Number of items per page (default: 20-50 depending on endpoint)
  • after - Cursor for the next page (use the last item's ID from previous response)

Response Format​

{
  "items": [...],
  "hasMore": true,
  "next": {
    "after": "org_abc123"
  }
}

Example Pagination Flow​

# First page
GET /v1/organizations?limit=10

# Next page using the last item's ID
GET /v1/organizations?limit=10&after=org_abc123

The after parameter should be set to the id of the last item from the current page to retrieve the next page of results.