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

# Get payout

> One payout of the /payouts list, by its uuid.

> [!NOTE]
>
> Each payout has a `state`: `ready`, `canceled`, or `updating` while it
> recalculates. An `updating` payout has `pending_update: true` and `null`
> amounts, dates, views and content counts until it's ready. While payouts are
> being recalculated for your whole organization, every row comes back `updating`
> with null amounts. Call again in a few minutes.


## OpenAPI

````yaml GET /payouts/{uuid}
openapi: 3.0.1
info:
  title: Growi API
  description: >-
    API documentation for Growi platform, showcasing the public tracking event
    endpoint
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.growi.io/api/public/v1
security:
  - bearerAuth: []
paths:
  /payouts/{uuid}:
    get:
      summary: Get payout
      description: One payout of the /payouts list, by its uuid.
      parameters:
        - name: organization_id
          in: query
          required: false
          description: >-
            Read one of your child brands instead of the organization that owns
            the key. Any id that is not one of your brands answers 404.
          schema:
            type: integer
        - name: uuid
          in: path
          schema:
            type: string
          required: true
          description: 'The payout uuid: eight hex characters'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      uuid:
                        type: string
                      creator_id:
                        type: integer
                      creator_name:
                        type: string
                        nullable: true
                      creator_avatar_url:
                        type: string
                        nullable: true
                      campaign_id:
                        type: integer
                        nullable: true
                      campaign_name:
                        type: string
                      campaign_category:
                        type: string
                      amount:
                        type: string
                        nullable: true
                        description: Formatted, e.g. $123.00
                      amount_cents:
                        type: integer
                        nullable: true
                      deal_date:
                        type: string
                        format: date
                        nullable: true
                        description: The cycle's due date
                      since_date:
                        type: string
                        format: date
                        nullable: true
                        description: The cycle's start date
                      views:
                        type: string
                        nullable: true
                        description: e.g. "12,500 Views" or "Completed"
                      status:
                        type: string
                        description: >-
                          Due, Pending, In progress, Paid, Paid externally, Sent
                          from account, Canceled, Refunded, ...
                      contents_delivered:
                        type: integer
                        nullable: true
                      contents_required:
                        type: integer
                        nullable: true
                      credits_enabled:
                        type: boolean
                        nullable: true
                      credit_name:
                        type: string
                        nullable: true
                      total_credit_amount:
                        type: integer
                        nullable: true
                      formatted_total_credit_amount:
                        type: string
                        nullable: true
                      pending_update:
                        type: boolean
                        description: >-
                          true while the payout is recalculating: its amount,
                          dates, views and content counts are null until it
                          finishes
                  meta:
                    type: object
                    properties:
                      precomputed_count:
                        type: integer
                      queued_count:
                        type: integer
                      in_flight_count:
                        type: integer
                      filtered_unknown_count:
                        type: integer
                        nullable: true
                      queue_state:
                        type: string
                        description: >-
                          ok, or unavailable when values could not be verified
                          (they are then null)
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            `organization_id` isn't an active child brand of your organization,
            or the record doesn't exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Invalid or missing params. `error` says which
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Rate limited: 2 seconds between calls and an hourly cap per API key.
            See `Retry-After` and the `X-RateLimit-*` headers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ApiError:
      type: object
      properties:
        error:
          type: string
          description: What went wrong
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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