---
title: "Search and list ledger entries"
method: POST
path: "/app/v1/ledger/search"
tags: ["ledger"]
---

# Search and list ledger entries

`POST /app/v1/ledger/search`

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'owner_id' | 'project_group_id' | 'vintage' | 'status' | 'holding'
  - `sort_direction` 'asc' | 'desc' — Sort direction
  - `filter` object — A filter object for Ledger Entries where it can filter based on any of these following fields. No fields are mandatory and the syntax is roughly the same as MongoDB querying.
    - `owner_id` string, uuid
    - `project_group_id` string, uuid
    - `vintage` string
    - `status` string
    - `holding` string

## Response `200`

A successful operation

- object
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` LedgerEntry[]
    - `owner_id` string, uuid, required
    - `project_group_id` string, uuid, required
    - `vintage` string, required
    - `status` 'active' | 'retired' | 'removed', required
    - `range_start` integer, required
    - `range_end` integer, required
    - `holding` boolean, required
    - `serial_number_prefix` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `created_by` string, uuid
    - `updated_by` string, uuid
    - `company_id` string, uuid
    - `id` string, uuid
    - `serial_number_range` string
    - `credit_owner` CreditOwner
      - `name` string
      - `visibility` 'public' | 'private'
      - `buffer_holder` boolean
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `created_by` string, uuid
      - `updated_by` string, uuid
      - `company_id` string, uuid
      - `id` string, uuid
      - `public_name` string
    - `project_group` ProjectGroup
      - `name` string
      - `status` 'active' | 'closed'
      - `project_developer` string
      - `start_date` string, date
      - `end_date` string, date
      - `protocol` string
      - `country` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
      - `created_by` string, uuid
      - `updated_by` string, uuid
      - `company_id` string, uuid
      - `id` string, uuid

---

[API](https://skmtc.net/validere/apis/carbonhub-api.md) · [All operations](https://skmtc.net/validere/apis/carbonhub-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/validere/carbonhub-api/revisions/053edab62415/schema)