{
  "components": {
    "schemas": {
      "OutputDeveloperPortalAppReferral8a799ef974b0": {
        "description": "An app referral object as represented within Rippling.",
        "properties": {
          "admin_first_name": {
            "description": "First name of the customer company admin to contact regarding this referral.",
            "type": "string"
          },
          "admin_last_name": {
            "description": "Last name of the customer company admin to contact regarding this referral.",
            "type": "string"
          },
          "admin_title": {
            "description": "Title of the customer company admin (in the customer company) to contact regarding this referral.",
            "type": "string"
          },
          "admin_work_email": {
            "description": "Work email of the customer company admin to contact regarding this referral.",
            "type": "string"
          },
          "admin_work_phone": {
            "description": "Phone number of the customer company admin to contact regarding this referral.",
            "type": "string"
          },
          "app_display_name": {
            "description": "Display name of the app this app referral record is for.",
            "type": "string"
          },
          "billing_address_city": {
            "anyOf": [
              {
                "description": "Billing address city of the customer company.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "billing_address_country": {
            "anyOf": [
              {
                "description": "Billing address country of the customer company.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "billing_address_line_1": {
            "anyOf": [
              {
                "description": "Billing address line 1 of the customer company.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "billing_address_line_2": {
            "anyOf": [
              {
                "description": "Billing address line 2 of the customer company, typically floor or unit number is stored here.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "billing_address_state": {
            "anyOf": [
              {
                "description": "Billing address state of the customer company.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "billing_address_zip_code": {
            "anyOf": [
              {
                "description": "Billing address zip code of the customer company.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "contractor_count": {
            "anyOf": [
              {
                "description": "Total number of active contractors in the customer company.",
                "minimum": 0,
                "type": "integer"
              },
              {
                "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$",
                "type": "string"
              }
            ]
          },
          "dba_name": {
            "anyOf": [
              {
                "description": "The doing business as name of the customer company.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "employee_count": {
            "anyOf": [
              {
                "description": "Total number of active employees including contractors in the customer company.",
                "minimum": 0,
                "type": "integer"
              },
              {
                "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$",
                "type": "string"
              }
            ]
          },
          "global_contractor_count": {
            "anyOf": [
              {
                "description": "Total number of active global contractors in the customer company. Global means outside of the country the customer company is primarily based out of.",
                "minimum": 0,
                "type": "integer"
              },
              {
                "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$",
                "type": "string"
              }
            ]
          },
          "global_employee_count": {
            "anyOf": [
              {
                "description": "Total number of active global employees in the customer company. Global means outside of the country the customer company is primarily based out of.",
                "minimum": 0,
                "type": "integer"
              },
              {
                "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$",
                "type": "string"
              }
            ]
          },
          "id": {
            "description": "Rippling side id for the app referral record.",
            "type": "string"
          },
          "legal_name": {
            "description": "Legal name of the customer company.",
            "type": "string"
          },
          "website_url": {
            "anyOf": [
              {
                "description": "Website url of the customer company.",
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "title": "App Referral",
        "type": "object"
      }
    }
  },
  "info": {
    "title": "Rippling developer-portal",
    "version": "2026-10-28"
  },
  "openapi": "3.1.0",
  "paths": {
    "/platform/api/app_referrals": {
      "get": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/developer-portal/reference/get-app-referrals"
        },
        "operationId": "rippling.developer_portal.get_app_referrals",
        "parameters": [
          {
            "in": "query",
            "name": "limit",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "in": "query",
            "name": "offset",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "items": {
                    "$ref": "#/components/schemas/OutputDeveloperPortalAppReferral8a799ef974b0"
                  },
                  "type": "array"
                }
              }
            },
            "description": "OK"
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com"
          }
        ],
        "summary": "GET All App Referrals",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      }
    },
    "/platform/api/app_referrals/{appReferralId}": {
      "get": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/developer-portal/reference/get-app-referrals-app-referral-id"
        },
        "operationId": "rippling.developer_portal.get_app_referrals_appreferralid",
        "parameters": [
          {
            "in": "path",
            "name": "appReferralId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OutputDeveloperPortalAppReferral8a799ef974b0"
                }
              }
            },
            "description": "OK"
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com"
          }
        ],
        "summary": "GET Single App Referral",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      }
    }
  }
}