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

# Retrieve a conversion



## OpenAPI

````yaml /api-reference/openapi.json get /conversions/{conversion_id}/
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/{conversion_id}/:
    get:
      tags:
        - Conversions
      summary: Retrieve a conversion
      operationId: retrieveAConversion
      parameters:
        - name: conversion_id
          in: path
          description: Numeric `id` of the conversion to perform action with.
          required: true
          example: '1'
          schema:
            type: number
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversionModel'
              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
                affiliate_meta_data:
                  subid1: baz
                meta_data:
                  foo: bar
                  tap: awesome
                created_at: 2021-03-03T12:39:19+0000
                warnings: null
                tracking_source: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    ConversionModel:
      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
    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:
    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
    NotFound:
      description: The object does not exist or belongs to another account
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Not Found
            code: 404
            traceId: 7ae8e92b77572da03805
  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.