List customers

​

List Customer records with cursor pagination. limit is a maximum: a page can hold fewer records while next_cursor is still set, so iterate until it is null. Filters on currency and amount match the record's own currency.

Query Parameters
  • external_ids
    Type: array string[] | null · External Ids …100nullable

    Exact external ids to return (repeat the key). At most 100.

  • currencies
    Type: array string[] | null · Currenciesnullable

    ISO 4217 codes (repeat the key). Matches the record's own currency, not the entity's functional currency.

  • platforms
    Type: array string[] | null · Platformsnullable

    Source platforms the records were ingested from (e.g. stripe, ramp). Customer-inserted records carry the platform they declared, or api.

  • platform_object_ids
    Type: array string[] | null · Platform Object Idsnullable

    The source platform's own ids for the records (e.g. a Stripe in_… id).

  • include_deleted
    Type: boolean · Include Deleted

    Include records act has since deleted. They carry customFields.t0_deleted_at. Default false: deleted records are omitted.

  • cursor
    Type: string · Cursornullable

    Opaque cursor from the previous page's next_cursor. Omit for the first page.

  • limit
    Type: integer · Limit
    min:  
    1
    max:  
    200

    Maximum records per page (1-200). A page can hold fewer while next_cursor is still set; iterate until it is null.

  • include_total
    Type: boolean · Include Total

    Also return total, the number of matching records before the deleted overlay.

  • order
    Type: string · Orderenum

    Sort direction.

    values
    • asc
    • desc
  • date_from
    Type: string · Date FromFormat: datenullable

    Inclusive lower bound on the record's date.

  • date_to
    Type: string · Date ToFormat: datenullable

    Inclusive upper bound on the record's date.

  • sort
    const:  
    date

    Field to sort by. Amount sorts order by the functional-currency value Leapfin holds (order-equivalent within one currency); filter by one currency for a coherent amount order.

  • expand
    Type: array string[] | null · Expandenumnullable

    Linked records to include under expanded (repeat the key).

    values
    • invoices
    • payments
Headers
  • X-Api-Key
    Type: string · X-Api-Keynullable
Responses
  • application/json
  • 400

    Amount filter without exactly one currency (CAPI64), or a cursor that does not match the request's filters (CAPI65).

  • 401

    Missing or invalid X-Api-Key (CAPI11).

  • 403

    The key lacks the customer_api:read permission (CAPI71).

  • 409

    The entity has no applied books start date (CAPI67).

  • application/json
Request Example for get/v1/customers
curl /v1/customers \
  --header 'X-Api-Key: YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": {
        "dataType": "Adjustment",
        "externalId": "string",
        "platformDataType": "string",
        "platformId": "string",
        "platformType": "string"
      },
      "data": {
        "customFields": {
          "additionalProperty": "anything"
        },
        "date": "2026-09-10",
        "email": "string",
        "name": "string"
      },
      "links": [
        {
          "dataType": "Adjustment",
          "externalId": "string",
          "platformDataType": "string",
          "platformId": "string",
          "platformType": "string"
        }
      ],
      "expanded": {
        "additionalProperty": [
          {
            "data": {
              "amount": 1,
              "currencyCode": "string",
              "customFields": {
                "additionalProperty": "anything"
              },
              "date": "2026-09-10",
              "description": "string",
              "endDate": "2026-09-10",
              "exchangeRates": [],
              "startDate": "2026-09-10"
            },
            "id": {
              "dataType": "Adjustment",
              "externalId": "string",
              "platformDataType": "string",
              "platformId": "string",
              "platformType": "string"
            },
            "links": []
          }
        ]
      },
      "expanded_truncated": [
        "string"
      ]
    }
  ],
  "next_cursor": "string",
  "as_of": "2026-09-10T20:14:13.740Z",
  "total": 1
}

Successful Response