> ## 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 charity request status

> Whether a registration is listed on Donate.gg, waiting for review, needs more information, was reviewed without a listing, or has not been requested. While waiting, `queue` estimates how many requests are ahead and how long recent requests took; review order and timing are not guaranteed. Reads Donate.gg only; it does not check the register or create a request.



## OpenAPI

````yaml https://api.donate.gg/api/openapi get /v1/charity-requests/{register}/{registration}
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 later `/v2`).
    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:
  /v1/charity-requests/{register}/{registration}:
    get:
      summary: Get charity request status
      description: >-
        Whether a registration is listed on Donate.gg, waiting for review, needs
        more information, was reviewed without a listing, or has not been
        requested. While waiting, `queue` estimates how many requests are ahead
        and how long recent requests took; review order and timing are not
        guaranteed. Reads Donate.gg only; it does not check the register or
        create a request.
      operationId: v1.charityRequests.status
      parameters:
        - name: register
          in: path
          required: true
          schema:
            enum:
              - united-states
              - england-wales
              - scotland
              - northern-ireland
              - france
              - japan
              - new-zealand
              - norway
              - netherlands
              - canada
              - australia
            type: string
            description: Register id from GET /charity-requests/registers
        - name: registration
          in: path
          required: true
          schema:
            type: string
            description: Registration number
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  register:
                    enum:
                      - united-states
                      - england-wales
                      - scotland
                      - northern-ireland
                      - france
                      - japan
                      - new-zealand
                      - norway
                      - netherlands
                      - canada
                      - australia
                    type: string
                    description: Register id from GET /charity-requests/registers
                  registration:
                    type: string
                    description: Canonical registration number
                  status:
                    enum:
                      - listed
                      - requested
                      - needs_info
                      - reviewed
                      - not_requested
                    type: string
                  charity:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                          slug:
                            type: string
                        required:
                          - id
                          - slug
                        additionalProperties: false
                        description: >-
                          The public charity, when this registration is listed
                          on Donate.gg
                      - type: 'null'
                  queue:
                    anyOf:
                      - type: object
                        properties:
                          ahead:
                            type: number
                            description: >-
                              Requests waiting for review that were submitted
                              before this one
                          typicalSeconds:
                            anyOf:
                              - type: number
                              - type: 'null'
                            description: >-
                              Typical seconds from submission to listing for
                              recent requests, or null without enough recent
                              history
                        required:
                          - ahead
                          - typicalSeconds
                        additionalProperties: false
                        description: Present while the request is waiting for review
                      - type: 'null'
                required:
                  - register
                  - registration
                  - status
                  - charity
                  - queue
                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: true
                      code:
                        const: INVALID_REGISTRATION
                      status:
                        const: 400
                      message:
                        type: string
                        default: >-
                          This registration number cannot be used with the
                          selected register
                      data:
                        type: object
                        properties:
                          error:
                            type: string
                          code:
                            const: INVALID_REGISTRATION
                        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.