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

# Search eligible beneficiaries

> Bounded typeahead over beneficiaries already available on Donate. Omit type for all, or select pipe-separated types such as charity|campaign. campaignSource filters only campaigns in the selected types.



## OpenAPI

````yaml https://api.donate.gg/api/openapi get /v2/beneficiaries/search
openapi: 3.1.1
info:
  title: Donate Developer API
  version: 1.0.0
  description: >-
    Public JSON API for charities, configs, campaigns, tokens, and related
    catalog reads. Operations are grouped by version (`/v1` and `/v2`). V2
    supports named charity and campaign beneficiaries; v1 preserves user/charity
    config shapes. GET/HEAD catalog routes may omit `donate-api-key` and are IP
    rate-limited for anonymous callers (~20 req/min). Authenticated keys share
    one organization rate-tier bucket. Create/list configs and project analytics
    require an API key. Configs are permanent; the retained authenticated DELETE
    endpoint rejects deletion. Unpublished internal routes are omitted. Spec
    routes (`/api/openapi`, `/api/postman`) are unauthenticated and unmetered.
servers:
  - url: /api
    description: API origin. Version prefixes live on each operation path.
security:
  - {}
  - ApiKeyAuth: []
paths:
  /v2/beneficiaries/search:
    get:
      summary: Search eligible beneficiaries
      description: >-
        Bounded typeahead over beneficiaries already available on Donate. Omit
        type for all, or select pipe-separated types such as charity|campaign.
        campaignSource filters only campaigns in the selected types.
      operationId: v2.beneficiaries.search
      parameters:
        - name: term
          in: query
          required: true
          schema:
            type: string
          allowEmptyValue: true
          allowReserved: true
        - name: limit
          in: query
          required: false
          schema:
            type: number
            default: 10
          allowEmptyValue: true
          allowReserved: true
        - name: type
          in: query
          required: false
          schema:
            type: string
            maxLength: 200
            pattern: ^(?:charity|campaign)(?:\|(?:charity|campaign))*$
          allowEmptyValue: true
          allowReserved: true
        - name: campaignSource
          in: query
          required: false
          schema:
            enum:
              - donate
              - tiltify
            type: string
            description: Filters campaign results only; charity results are unaffected.
          allowEmptyValue: true
          allowReserved: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  response:
                    type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            logo:
                              type: string
                              description: >-
                                Public image URL, or the Donate placeholder when
                                no image is available.
                            type:
                              const: charity
                          required:
                            - id
                            - name
                            - logo
                            - type
                          additionalProperties: false
                        - type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            logo:
                              type: string
                              description: >-
                                Public image URL, or the Donate placeholder when
                                no image is available.
                            type:
                              const: campaign
                            source:
                              enum:
                                - donate
                                - tiltify
                              type: string
                          required:
                            - id
                            - name
                            - logo
                            - type
                            - source
                          additionalProperties: false
                required:
                  - response
                additionalProperties: false
        '400':
          description: '400'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: VALIDATION_ERROR
                      status:
                        const: 400
                      message:
                        type: string
                        default: Validation failed
                      data:
                        type: object
                        properties:
                          error:
                            type: string
                          code:
                            const: VALIDATION_ERROR
                          issues:
                            type: array
                            items:
                              anyOf:
                                - {}
                                - type: 'null'
                        required:
                          - error
                          - code
                        additionalProperties: false
                    required:
                      - defined
                      - code
                      - status
                      - message
                  - type: object
                    properties:
                      defined:
                        const: false
                      code:
                        type: string
                      status:
                        type: number
                      message:
                        type: string
                      data: {}
                    required:
                      - defined
                      - code
                      - status
                      - message
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: donate-api-key
      description: >-
        Developer API key. Required for config create/list and project
        analytics. The disabled config DELETE endpoint also requires
        authentication. Optional on public GET reads (anonymous callers are IP
        rate-limited). Obtain from the Developer dashboard.

````

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