> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.byteful.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Mobile Ledger

> Search for entries in the Mobile Ledger using various filters.




## OpenAPI

````yaml get /public/user/mobile_ledger/search
openapi: 3.0.1
info:
  title: Byteful Public User API
  description: Public API used for third-party usage.
  termsOfService: https://byteful.com
  contact:
    url: https://byteful.com
    email: developer@byteful.com
  version: '1.0'
  x-logo:
    altText: Byteful
    backgroundColor: '#6354eb'
    url: >-
      https://pbs.twimg.com/profile_banners/1038803520605118464/1729783007/1500x500
servers:
  - url: https://api.byteful.com/1.0/
security: []
paths:
  /public/user/mobile_ledger/search:
    get:
      tags:
        - Mobile Ledger
      summary: Search Mobile Ledger
      description: |
        Search for entries in the Mobile Ledger using various filters.
      parameters:
        - name: mobile_ledger_id
          in: query
          description: Unique identifier of the Mobile Ledger entry.
          schema:
            type: string
        - name: service_id
          in: query
          description: Service identifier associated with the ledger entry.
          schema:
            type: string
        - name: service_adjustment_id
          in: query
          description: Adjustment identifier associated with the ledger entry.
          schema:
            type: integer
        - name: mobile_ledger_reason
          in: query
          description: Reason for the ledger entry.
          schema:
            type: string
        - name: mobile_ledger_requests
          in: query
          description: Number of requests recorded in the ledger entry.
          schema:
            type: integer
        - name: mobile_ledger_bytes
          in: query
          description: Data usage in bytes recorded in the ledger entry.
          schema:
            type: integer
        - name: mobile_ledger_period_date
          in: query
          description: The date of the ledger entry.
          schema:
            type: string
        - name: mobile_ledger_creation_datetime
          in: query
          description: Creation datetime of the ledger entry.
          schema:
            type: string
        - name: mobile_ledger_last_update_datetime
          in: query
          description: Last update datetime of the ledger entry.
          schema:
            type: string
        - name: per_page
          in: query
          description: Number of items per page for pagination
          schema:
            type: integer
        - name: page
          in: query
          description: Page number for pagination
          schema:
            type: integer
        - name: sort_by
          in: query
          description: Key for sorting or random.
          schema:
            type: string
      responses:
        '200':
          description: Successful Mobile Ledger search
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/MobileLedgerSuccessfulSearchResponse'
      security:
        - APIPrivateKey: []
          APIPublicKey: []
components:
  schemas:
    MobileLedgerSuccessfulSearchResponse:
      type: object
      properties:
        data:
          type: array
          description: >-
            Array of Mobile Ledger items matching the search criteria up to the
            limit of per_page paramater.
          items:
            type: object
            properties:
              customer_id:
                type: integer
                example: 1955
              mobile_ledger_bytes:
                type: integer
                example: 128290101
              mobile_ledger_creation_datetime:
                type: string
                format: date-time
              mobile_ledger_id:
                type: string
                example: 123e4567-e89b-12d3-a456-426614174000
              mobile_ledger_last_update_datetime:
                type: string
                format: date-time
              mobile_ledger_period_date:
                type: string
                example: '2023-10-01'
              mobile_ledger_reason:
                type: string
                example: top_up
              mobile_ledger_requests:
                type: integer
                example: 1244
              service_adjustment_id:
                type: integer
                example: 10
              service_id:
                type: string
                example: API-1234-5678
        item_count:
          type: integer
          description: Total number of Mobile Ledger items returned in the data field.
        message:
          type: string
          description: Status message for the search.
        page:
          type: integer
          description: Current page number of the search results returned.
        per_page:
          type: integer
          description: Number of Mobile Ledger items returned per page.
        total_count:
          type: integer
          description: Total of Mobile Ledger items that match the search filter.
      description: Mobile Ledger search was successful.
      example:
        data:
          - customer_id: 1955
            mobile_ledger_bytes: 128290101
            mobile_ledger_creation_datetime: '2023-04-01 12:00:00'
            mobile_ledger_id: 123e4567-e89b-12d3-a456-426614174000
            mobile_ledger_last_update_datetime: '2023-04-02 12:00:00'
            mobile_ledger_period_date: '2023-10-01'
            mobile_ledger_reason: top_up
            mobile_ledger_requests: 1244
            service_adjustment_id: 10
            service_id: API-1234-5678
        item_count: 1
        message: Mobile Ledger search successful.
        page: 1
        per_page: 10
        total_count: 1
  securitySchemes:
    APIPrivateKey:
      type: apiKey
      description: ' Private API key for user-level authentication.'
      name: X-API-Private-Key
      in: header
    APIPublicKey:
      type: apiKey
      description: ' Public API key for user-level authentication.'
      name: X-API-Public-Key
      in: header

````