openapi: 3.1.0
info:
  title: Givebutter Pledges API
  version: 1.0.0
  description: The Pledges surface of the Givebutter Public API — 2 operation(s). Split by tag from Givebutter's
    own published OpenAPI at https://givebutter.com/docs/api.json (harvested 2026-09-12). Operations, schemas and
    responses are verbatim from the provider's spec.
  contact:
    name: Givebutter API Documentation
    url: https://docs.givebutter.com/api-reference/authentication
servers:
- url: https://api.givebutter.com/
security:
- http: []
tags:
- name: Pledges
paths:
  /v1/pledges:
    get:
      operationId: pledges.index
      summary: List all pledges
      tags:
      - Pledges
      responses:
        '200':
          description: Paginated set of `PledgeResource`
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PledgeResource'
                  links:
                    type: object
                    properties:
                      first:
                        type:
                        - string
                        - 'null'
                      last:
                        type:
                        - string
                        - 'null'
                      prev:
                        type:
                        - string
                        - 'null'
                      next:
                        type:
                        - string
                        - 'null'
                    required:
                    - first
                    - last
                    - prev
                    - next
                  meta:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        minimum: 1
                      from:
                        type:
                        - integer
                        - 'null'
                        minimum: 1
                      last_page:
                        type: integer
                        minimum: 1
                      links:
                        type: array
                        description: Generated paginator links.
                        items:
                          type: object
                          properties:
                            url:
                              type:
                              - string
                              - 'null'
                            label:
                              type: string
                            active:
                              type: boolean
                          required:
                          - url
                          - label
                          - active
                      path:
                        type:
                        - string
                        - 'null'
                        description: Base path for paginator generated URLs.
                      per_page:
                        type: integer
                        description: Number of items shown per page.
                        minimum: 0
                      to:
                        type:
                        - integer
                        - 'null'
                        description: Number of the last item in the slice.
                        minimum: 1
                      total:
                        type: integer
                        description: Total number of items being paginated.
                        minimum: 0
                    required:
                    - current_page
                    - from
                    - last_page
                    - links
                    - path
                    - per_page
                    - to
                    - total
                required:
                - data
                - links
                - meta
  /v1/pledges/{pledge}:
    get:
      operationId: pledges.show
      summary: Get a pledge
      tags:
      - Pledges
      parameters:
      - name: pledge
        in: path
        required: true
        description: The pledge ID
        schema:
          type: integer
      responses:
        '200':
          description: '`PledgeResource`'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PledgeResource'
        '403':
          $ref: '#/components/responses/AuthorizationException'
        '404':
          $ref: '#/components/responses/ModelNotFoundException'
components:
  responses:
    ModelNotFoundException:
      description: Not found
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
            - message
    AuthorizationException:
      description: Authorization error
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
                description: Error overview.
            required:
            - message
  schemas:
    PledgeResource:
      type: object
      properties:
        id:
          type: string
        contact_id:
          type: string
        campaign_id:
          type: string
        fund_id:
          type: string
        type:
          type: string
        status:
          type: string
        status_friendly:
          type: string
        amount:
          type: string
        amount_fulfilled:
          type: string
        amount_remaining:
          type: string
        allow_custom_amount:
          type: string
        installment_frequency:
          type: string
        first_installment_date:
          type: string
        next_installment_date:
          type: string
        expected_fulfillment_date:
          type: string
        memo:
          type: string
        auto_remind:
          type: string
        last_reminded_at:
          type: string
        fee_coverage_type:
          type: string
        fee_coverage_visibility:
          type: string
        include_in_campaign_goal:
          type: string
        tips_enabled:
          type: string
        canceled_at:
          type: string
        pledged_at:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      required:
      - id
      - contact_id
      - campaign_id
      - fund_id
      - type
      - status
      - status_friendly
      - amount
      - amount_fulfilled
      - amount_remaining
      - allow_custom_amount
      - installment_frequency
      - first_installment_date
      - next_installment_date
      - expected_fulfillment_date
      - memo
      - auto_remind
      - last_reminded_at
      - fee_coverage_type
      - fee_coverage_visibility
      - include_in_campaign_goal
      - tips_enabled
      - canceled_at
      - pledged_at
      - created_at
      - updated_at
      title: PledgeResource
  securitySchemes:
    http:
      type: http
      scheme: bearer
x-source: https://givebutter.com/docs/api.json
x-harvested: '2026-09-12'