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

# List all affiliate prospects



## OpenAPI

````yaml /api-reference/openapi.json get /affiliate-prospects/
openapi: 3.0.3
info:
  title: Tapfiliate REST API
  version: '1.6'
  description: >-
    Reference for the Tapfiliate REST API. See the introduction for
    authentication, pagination and rate limits.
  x-generated-from: ApiBlueprint@e23e51f
servers:
  - url: https://api.tapfiliate.com/1.6
    description: Production
security:
  - ApiKey: []
tags:
  - name: Customers
    description: >-
      People who signed up or paid after being referred by an affiliate. With
      recurring or lifetime commissions, later conversions for the same customer
      go to the same affiliate.
  - name: Conversions
    description: >-
      Sales and other actions you pay commissions for. Each conversion has one
      or more commissions.
  - name: Commissions
    description: >-
      What an affiliate earns for a conversion. Approve or disapprove them
      before payout.
  - name: Affiliates
    description: >-
      The partners who promote your programs, with their meta data, notes,
      payout methods and balances.
  - name: Affiliate Groups
    description: Groups for organising your affiliates.
  - name: Affiliate Prospects
    description: >-
      People who signed up through a recruitment source but are not affiliates
      yet.
  - name: Programs
    description: >-
      Your affiliate programs, the affiliates in them and their commission
      settings.
  - name: Payments
    description: Settle affiliate balances and look up past payments.
  - name: Clicks
    description: Visits through affiliate links, the first step of attribution.
paths:
  /affiliate-prospects/:
    get:
      tags:
        - Affiliate Prospects
      summary: List all affiliate prospects
      operationId: listAllAffiliateProspects
      parameters:
        - name: email
          in: query
          description: An email address
          example: peter@example-existing-customer.inc
          schema:
            type: string
        - name: referral_code
          in: query
          description: >-
            An affiliate prospect's referral code. This corresponds to the value
            of `ref=` in their referral link.
          example: yza5njg
          schema:
            type: string
        - name: program_id
          in: query
          description: Retrieves affiliate prospects for a certain program
          example: johns-affiliate-program
          schema:
            type: string
        - name: group_id
          in: query
          description: Retrieves affiliate prospects for a certain affiliate group
          schema:
            type: string
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: string
                    firstname:
                      type: string
                    lastname:
                      type: string
                    email:
                      type: string
                    company:
                      type: object
                      properties:
                        name:
                          type: string
                        description:
                          type: string
                    address:
                      type: object
                      properties:
                        address:
                          type: string
                        address_two:
                          nullable: true
                        postal_code:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        country:
                          type: object
                          properties:
                            code:
                              type: string
                            name:
                              type: string
                    signup_source:
                      type: string
                    referral_link:
                      type: object
                      properties:
                        link:
                          type: string
                        asset_id:
                          type: string
                        source_id:
                          type: string
                    created_at:
                      type: string
                    promoted_at:
                      nullable: true
                    promotion_method:
                      nullable: true
              example:
                - id: peterpeterson
                  firstname: Peter
                  lastname: Peterson
                  email: peter@example-existing-customer.inc
                  company:
                    name: Example prospect Inc.
                    description: Great affiliate prospect
                  address:
                    address: 1 Holywood Drive
                    address_two: null
                    postal_code: '90210'
                    city: Los Angeles
                    state: CA
                    country:
                      code: US
                      name: United States
                  signup_source: stripe-integration
                  referral_link:
                    link: https://tapper.inc/johns-cool-product/?ref=yza5njg
                    asset_id: 1-aaaaaa
                    source_id: 3-rrrrrr
                  created_at: '2021-05-27T11:39:03+00:00'
                  promoted_at: null
                  promotion_method: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  responses:
    Unauthorized:
      description: The API key is missing or wrong
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Authentication Failed.
            code: 401
    Forbidden:
      description: No API access or no permission for this action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Forbidden
            code: 403
            traceId: 04ed655728a22bc0d39f
  schemas:
    RequestError:
      type: object
      description: >-
        Errors raised before the endpoint runs: authentication, access, unknown
        path, server error.
      properties:
        message:
          type: string
        code:
          type: integer
        traceId:
          type: string
          description: Send this to support to find the request.
      required:
        - message
        - code
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Your API key, from your Tapfiliate account settings.

````

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