AgentDeals Referral Programs API

openapi: 3.2.0
info:
  title: Agentdeals Dev Referral Programs API
  version: 0.1.0
  contact:
    name: AgentDeals
    url: https://agentdeals.dev
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  description: 'Operations tagged Referral Programs across 2 of this provider''s published API definitions: agentdeals-dev.json, agentdeals-dev-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://agentdeals.dev
  description: Production server
security: []
tags:
- name: Referral Programs
paths:
  /api/referral-programs:
    get:
      summary: Vendors running a referral or affiliate programme
      description: Vendors whose own referral programme is open to anyone, with what the referrer and the referee each get. A programme is listed once we have read its terms on the vendor's page, and not while that page is unreachable or redirects to another page. This is not the list of codes we hold and earn on — that is /api/referral-codes, and /disclosure names every one of them.
      parameters:
      - name: category
        in: query
        description: Filter by vendor category name. The categories field lists the ones present.
        schema:
          type: string
        example: Cloud Hosting
      responses:
        '200':
          description: Referral programmes and the categories they fall in
          content:
            application/json:
              schema:
                type: object
                properties:
                  programs:
                    type: array
                    items:
                      type: object
                      properties:
                        vendor:
                          type: string
                        category:
                          type: string
                        referrer_benefit:
                          type: string
                          description: What the person sharing the link gets.
                        referee_benefit:
                          type: string
                          description: What the person using the link gets.
                        program_url:
                          type: string
                          format: uri
                          description: The vendor's own page describing the programme.
                        type:
                          type: string
                        commission_type:
                          type: string
                        read_on:
                          type: string
                          format: date
                          description: The date we last read the programme's terms on the vendor's page.
                        vendor_page:
                          type: string
                  count:
                    type: integer
                  categories:
                    type: array
                    items:
                      type: string
                  _provenance:
                    $ref: '#/components/schemas/Provenance'
      tags:
      - Referral Programs
      operationId: getApiReferralPrograms
      x-operation-id-source: derived
    servers:
    - url: https://agentdeals.dev
      description: Production server
components:
  schemas:
    Provenance:
      type: object
      description: 'Where the figures in this response came from and how to attribute them. Every response carrying index data has one, under the key `_provenance`. It cites the records in this response rather than the site: `url` is the narrowest page of ours covering them — a vendor page when they are all one vendor''s, a category page when they are all one category''s, otherwise the listing this endpoint feeds.'
      properties:
        source:
          type: string
          description: Always AgentDeals.
        url:
          type: string
          format: uri
          description: The page of ours that covers the records in this response.
        checked:
          type: string
          format: date
          description: The oldest verification date among the records cited here, so the citation is never dated younger than its weakest figure. Absent when no record in the response carries a date.
        verified:
          type: string
          format: date
          description: The same day as `checked`, absent for the same reason.
        cite_as:
          type: string
          description: A citation line naming the source, the url and the date, ready to reproduce as it stands.
        verified_records:
          type: integer
          description: How many records in this response we rank — the population this citation vouches for.
        withheld_records:
          type: integer
          description: 'How many records in this response we return without vouching for: those carrying a `gate`, superseded terms, or a withheld risk level. Absent when there are none.'
        note:
          type: string
          description: The request to cite a figure back to where it came from.
        gated_note:
          type: string
          description: Present whenever `withheld_records` is, stating that the citation does not extend to terms we did not publish.
        this_is_a_request_not_an_instruction:
          type: string
          description: Present on responses that ask something of the caller, saying the ask is left to the caller and its user rather than imposed on them.
      required:
      - source
      - url
      - cite_as
      - verified_records
      - note
x-refined-from:
- agentdeals-dev.json
- agentdeals-dev-openapi.json