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



## OpenAPI

````yaml /api-reference/openapi.json get /conversions/
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:
  /conversions/:
    get:
      tags:
        - Conversions
      summary: List all conversions
      operationId: listAllConversions
      parameters:
        - name: program_id
          in: query
          description: The program Id
          example: johns-affiliate-program
          schema:
            type: string
        - name: external_id
          in: query
          description: >-
            The external Id. This is the unique id from your system or shopping
            cart. This id was passed when the conversions was first tracked.
          example: ORD123
          schema:
            type: string
        - name: affiliate_id
          in: query
          description: The affiliate Id
          example: janejameson
          schema:
            type: string
        - name: pending
          in: query
          description: Only show conversions that have pending commissions
          schema:
            type: boolean
        - name: date_from
          in: query
          description: Date From, a day in UTC
          example: '2022-01-01'
          schema:
            type: string
        - name: date_to
          in: query
          description: Date To, a day in UTC
          example: '2099-12-31'
          schema:
            type: string
        - name: use_profile_timezone
          in: query
          description: >-
            Deprecated, has no effect: time in Tapfiliate is UTC for every
            account, so `date_from` and `date_to` are always days in UTC
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversionsCollectionModel'
              example:
                - id: 1
                  external_id: ORD123
                  amount: 550
                  click:
                    created_at: 2021-03-03T12:39:19+0000
                    referrer: https://example-blog.inc/check-out-johns-product/
                    landing_page: https://tapper.inc/johns-cool-product/
                  commissions:
                    - id: 1
                      conversion_sub_amount: 550
                      amount: 55
                      commission_type: standard
                      approved: true
                      affiliate:
                        id: janejameson
                        firstname: Jane
                        lastname: Jameson
                      kind: regular
                      currency: USD
                      created_at: null
                      payout: null
                      comment: null
                      final: null
                      commission_name: standard
                  program:
                    id: johns-affiliate-program
                    title: John's affiliate program
                    currency: USD
                  affiliate:
                    id: janejameson
                    firstname: Jane
                    lastname: Jameson
                  customer:
                    id: cu_eXampl30th3r
                    customer_id: USER999
                    status: paying
                  meta_data:
                    foo: bar
                    tap: awesome
                  created_at: 2021-03-03T12:39:19+0000
                  warnings: null
                  affiliate_meta_data:
                    subid1: baz
                  tracking_source: null
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    ConversionsCollectionModel:
      type: array
      items:
        type: object
        properties:
          id:
            type: number
          external_id:
            type: string
          amount:
            type: number
          click:
            type: object
            properties:
              created_at:
                type: string
              referrer:
                type: string
              landing_page:
                type: string
          commissions:
            type: array
            items:
              type: object
              properties:
                id:
                  type: number
                conversion_sub_amount:
                  type: number
                amount:
                  type: number
                commission_type:
                  type: string
                approved:
                  type: boolean
                affiliate:
                  type: object
                  properties:
                    id:
                      type: string
                    firstname:
                      type: string
                    lastname:
                      type: string
                kind:
                  type: string
                currency:
                  type: string
                created_at:
                  nullable: true
                payout:
                  nullable: true
                comment:
                  nullable: true
                final:
                  nullable: true
                commission_name:
                  type: string
          program:
            type: object
            properties:
              id:
                type: string
              title:
                type: string
              currency:
                type: string
          affiliate:
            type: object
            properties:
              id:
                type: string
              firstname:
                type: string
              lastname:
                type: string
          customer:
            type: object
            properties:
              id:
                type: string
              customer_id:
                type: string
              status:
                type: string
          affiliate_meta_data:
            type: object
            properties:
              subid1:
                type: string
          meta_data:
            type: object
            properties:
              foo:
                type: string
              tap:
                type: string
          created_at:
            type: string
          warnings:
            nullable: true
          tracking_source:
            nullable: true
    ErrorList:
      type: object
      description: Business and validation errors raised by an endpoint.
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
                description: Machine-readable code, on 409 responses.
              property_path:
                type: string
                description: The invalid field, on validation errors.
            required:
              - message
      required:
        - errors
    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
  responses:
    BadRequest:
      description: The request is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorList'
          example:
            errors:
              - message: Missing mandatory parameter(s)
    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
  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.