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

# Ledger

> List where the organization's shared credit went, newest first

CLI: `adside credits ledger`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/organizations/{organizationId}/credits/ledger
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/organizations/{organizationId}/credits/ledger:
    get:
      tags:
        - Credits
      summary: Ledger
      description: |-
        List where the organization's shared credit went, newest first

        CLI: `adside credits ledger`
      operationId: credits.ledger
      parameters:
        - name: organizationId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: from
          in: query
          required: false
          schema:
            type: string
            format: date-time
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          style: form
          explode: true
        - name: to
          in: query
          required: false
          schema:
            type: string
            format: date-time
            pattern: >-
              ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
          style: form
          explode: true
        - name: workspaceId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          style: form
          explode: true
        - name: runId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          style: form
          explode: true
        - name: jobId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          style: form
          explode: true
        - name: source
          in: query
          required: false
          schema:
            type: string
            enum:
              - media
              - inference
              - credit
          style: form
          explode: true
        - name: aiUsageEventId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
          style: form
          explode: true
        - name: type
          in: query
          required: false
          schema:
            type: string
            enum:
              - starting_credit
              - top_up
              - charge
              - reversal
              - adjustment
          style: form
          explode: true
        - name: cursor
          in: query
          required: false
          schema:
            type: string
            pattern: ^[1-9]\d{0,9}$
          style: form
          explode: true
        - name: limit
          in: query
          required: false
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 100
          style: form
          explode: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  entries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        sequence:
                          type: integer
                          exclusiveMinimum: 0
                          maximum: 9007199254740991
                        type:
                          type: string
                          enum:
                            - starting_credit
                            - top_up
                            - charge
                            - reversal
                            - adjustment
                        createdAt:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                        description:
                          type: string
                        amountUsd:
                          type: number
                        balanceAfterUsd:
                          type: number
                        workspaceId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        jobId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        runId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        source:
                          type: string
                          enum:
                            - media
                            - inference
                            - credit
                        creditPurchaseId:
                          type: string
                        aiUsageEventId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        executionId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        threadId:
                          anyOf:
                            - type: string
                            - type: 'null'
                        actor:
                          anyOf:
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - user
                                    - agent
                                id:
                                  type: string
                                name:
                                  type: string
                              required:
                                - kind
                                - id
                                - name
                              additionalProperties: false
                            - type: 'null'
                      required:
                        - id
                        - sequence
                        - type
                        - createdAt
                        - description
                        - amountUsd
                        - balanceAfterUsd
                        - workspaceId
                        - jobId
                        - runId
                        - actor
                      additionalProperties: false
                  nextCursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                required:
                  - entries
                  - nextCursor
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.