> ## 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.

# Get a beneficiary profile

> Public presentation and eligibility. Create a config naming this type and id to donate.



## OpenAPI

````yaml https://api.donate.gg/api/openapi get /v2/beneficiary/{type}/{id}
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/beneficiary/{type}/{id}:
    get:
      summary: Get a beneficiary profile
      description: >-
        Public presentation and eligibility. Create a config naming this type
        and id to donate.
      operationId: v2.beneficiaries.getById
      parameters:
        - name: type
          in: path
          required: true
          schema:
            enum:
              - charity
              - campaign
            type: string
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                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
                      description:
                        type: string
                        description: Plain-text description with HTML markup removed.
                      url:
                        type: string
                      eligible:
                        type: boolean
                        description: >-
                          Whether this beneficiary can be selected for a new
                          config.
                    required:
                      - id
                      - name
                      - logo
                      - type
                      - description
                      - url
                      - eligible
                    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
                      description:
                        type: string
                        description: Plain-text description with HTML markup removed.
                      url:
                        type: string
                      eligible:
                        type: boolean
                        description: >-
                          Whether this beneficiary can be selected for a new
                          config.
                      sourceUrl:
                        anyOf:
                          - type: string
                          - type: 'null'
                    required:
                      - id
                      - name
                      - logo
                      - type
                      - source
                      - description
                      - url
                      - eligible
                      - sourceUrl
                    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
        '404':
          description: '404'
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      defined:
                        const: true
                      code:
                        const: NOT_FOUND
                      status:
                        const: 404
                      message:
                        type: string
                        default: Not found
                      data:
                        type: object
                        properties:
                          error:
                            type: string
                          code:
                            const: NOT_FOUND
                        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.