{
  "components": {
    "schemas": {}
  },
  "info": {
    "title": "Rippling recruiting-api",
    "version": "2026-10-28"
  },
  "openapi": "3.1.0",
  "paths": {
    "/external/application": {
      "get": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/recruiting-api/reference/get-application"
        },
        "operationId": "rippling.recruiting_api.get_application",
        "parameters": [
          {
            "in": "query",
            "name": "candidate_id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "Total Count": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$",
                          "type": "string"
                        }
                      ]
                    },
                    "items": {
                      "items": {
                        "properties": {
                          "appliedAt": {
                            "type": "string"
                          },
                          "candidate_id": {
                            "type": "string"
                          },
                          "hiringTeam": {
                            "properties": {
                              "recruiter": {
                                "type": "string"
                              },
                              "sourcingCredit": {
                                "type": "string"
                              }
                            },
                            "type": "object"
                          },
                          "id": {
                            "type": "string"
                          },
                          "job_id": {
                            "type": "string"
                          },
                          "stage": {
                            "type": "string"
                          },
                          "status": {
                            "type": "string"
                          },
                          "updatedAt": {
                            "type": "string"
                          }
                        },
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "offset": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "perChunk": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$",
                          "type": "string"
                        }
                      ]
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "description": "Bad Request",
            "x-rippling-source-response": {
              "description": "Bad Request"
            }
          },
          "401": {
            "description": "Unauthorized",
            "x-rippling-source-response": {
              "description": "Unauthorized"
            }
          },
          "403": {
            "description": "Forbidden",
            "x-rippling-source-response": {
              "description": "Forbidden"
            }
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com/ats2_provisioning/api"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com/ats2_provisioning/api"
          }
        ],
        "summary": "Get Applications",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      },
      "post": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/recruiting-api/reference/post-application"
        },
        "operationId": "rippling.recruiting_api.post_application",
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "application": {
                    "properties": {
                      "applicantCompany": {
                        "type": "string"
                      },
                      "email": {
                        "type": "string"
                      },
                      "first_name": {
                        "type": "string"
                      },
                      "hiringTeam": {
                        "properties": {
                          "sourcingCredit": {
                            "type": "string"
                          }
                        },
                        "type": "object"
                      },
                      "job_id": {
                        "type": "string"
                      },
                      "last_name": {
                        "type": "string"
                      },
                      "linkedin_link": {
                        "type": "string"
                      },
                      "location": {
                        "type": "string"
                      },
                      "phone_number": {
                        "type": "string"
                      },
                      "resume": {
                        "type": "string"
                      },
                      "resumeFileExtension": {
                        "type": "string"
                      }
                    },
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "appliedAt": {
                      "type": "string"
                    },
                    "candidate_id": {
                      "type": "string"
                    },
                    "hiringTeam": {
                      "properties": {
                        "recruiter": {
                          "type": "string"
                        },
                        "sourcingCredit": {
                          "type": "string"
                        }
                      },
                      "type": "object"
                    },
                    "id": {
                      "type": "string"
                    },
                    "job_id": {
                      "type": "string"
                    },
                    "stage": {
                      "type": "string"
                    },
                    "status": {
                      "type": "string"
                    },
                    "updatedAt": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "description": "Bad Request",
            "x-rippling-source-response": {
              "description": "Bad Request"
            }
          },
          "401": {
            "description": "Unauthorized",
            "x-rippling-source-response": {
              "description": "Unauthorized"
            }
          },
          "403": {
            "description": "Forbidden",
            "x-rippling-source-response": {
              "description": "Forbidden"
            }
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com/ats2_provisioning/api"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com/ats2_provisioning/api"
          }
        ],
        "summary": "Create Application",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      }
    },
    "/external/candidate": {
      "get": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/recruiting-api/reference/get-external-candidate"
        },
        "operationId": "rippling.recruiting_api.get_external_candidate",
        "parameters": [
          {
            "in": "query",
            "name": "createdAfter",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "email",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "firstName",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "lastName",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "offset",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "Total Count": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$",
                          "type": "string"
                        }
                      ]
                    },
                    "candidates": {
                      "items": {
                        "properties": {
                          "createdAt": {
                            "type": "string"
                          },
                          "email": {
                            "type": "string"
                          },
                          "first_name": {
                            "type": "string"
                          },
                          "id": {
                            "type": "string"
                          },
                          "last_name": {
                            "type": "string"
                          },
                          "phone_number": {
                            "type": [
                              "string",
                              "null"
                            ]
                          },
                          "timezone": {
                            "type": [
                              "string",
                              "null"
                            ]
                          }
                        },
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "offset": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "perChunk": {
                      "anyOf": [
                        {
                          "description": "Max number of elemented returned per request",
                          "type": "integer"
                        },
                        {
                          "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$",
                          "type": "string"
                        }
                      ]
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "description": "Bad Request",
            "x-rippling-source-response": {
              "description": "Bad Request"
            }
          },
          "401": {
            "description": "Unauthorized",
            "x-rippling-source-response": {
              "description": "Unauthorized"
            }
          },
          "403": {
            "description": "Forbidden",
            "x-rippling-source-response": {
              "description": "Forbidden"
            }
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com/ats2_provisioning/api"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com/ats2_provisioning/api"
          }
        ],
        "summary": "Get Candidates",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      }
    },
    "/external/job": {
      "get": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/recruiting-api/reference/get-external-job"
        },
        "operationId": "rippling.recruiting_api.get_external_job",
        "parameters": [
          {
            "in": "query",
            "name": "createdAfter",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "query",
            "name": "offset",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "Total Count": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$",
                          "type": "string"
                        }
                      ]
                    },
                    "jobs": {
                      "items": {
                        "properties": {
                          "createdAt": {
                            "type": "string"
                          },
                          "id": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          },
                          "requisitionId": {
                            "description": "Human-friendly 'id' to represent the job.",
                            "type": "string"
                          },
                          "stages": {
                            "items": {
                              "properties": {
                                "id": {
                                  "type": "string"
                                },
                                "name": {
                                  "type": "string"
                                }
                              },
                              "type": "object"
                            },
                            "type": "array"
                          },
                          "status": {
                            "type": "string"
                          }
                        },
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "offset": {
                      "type": [
                        "string",
                        "null"
                      ]
                    },
                    "perChunk": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "pattern": "^-?[0-9]+(?:\\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$",
                          "type": "string"
                        }
                      ]
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "description": "Bad Request",
            "x-rippling-source-response": {
              "description": "Bad Request"
            }
          },
          "401": {
            "description": "Unauthorized",
            "x-rippling-source-response": {
              "description": "Unauthorized"
            }
          },
          "403": {
            "description": "Forbidden",
            "x-rippling-source-response": {
              "description": "Forbidden"
            }
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com/ats2_provisioning/api"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com/ats2_provisioning/api"
          }
        ],
        "summary": "Get Jobs",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      }
    },
    "/external/job/{jobId}": {
      "get": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/recruiting-api/reference/get-external-job-single"
        },
        "operationId": "rippling.recruiting_api.get_external_job_single",
        "parameters": [
          {
            "in": "path",
            "name": "jobId",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "createdAt": {
                      "type": "string"
                    },
                    "id": {
                      "type": "string"
                    },
                    "name": {
                      "type": "string"
                    },
                    "requisitionId": {
                      "description": "Human-friendly 'id' to represent the job.",
                      "type": "string"
                    },
                    "stages": {
                      "items": {
                        "properties": {
                          "id": {
                            "type": "string"
                          },
                          "name": {
                            "type": "string"
                          }
                        },
                        "type": "object"
                      },
                      "type": "array"
                    },
                    "status": {
                      "type": "string"
                    }
                  },
                  "type": "object"
                }
              }
            },
            "description": "OK"
          },
          "400": {
            "description": "Bad Request",
            "x-rippling-source-response": {
              "description": "Bad Request"
            }
          },
          "401": {
            "description": "Unauthorized",
            "x-rippling-source-response": {
              "description": "Unauthorized"
            }
          },
          "403": {
            "description": "Forbidden",
            "x-rippling-source-response": {
              "description": "Forbidden"
            }
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com/ats2_provisioning/api"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com/ats2_provisioning/api"
          }
        ],
        "summary": "Get Job",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      }
    },
    "/external/utils/file_upload_url": {
      "get": {
        "externalDocs": {
          "url": "https://developer.rippling.com/documentation/recruiting-api/reference/get-ats-company-public-get-upload-url"
        },
        "operationId": "rippling.recruiting_api.get_ats_company_public_get_upload_url",
        "parameters": [
          {
            "in": "query",
            "name": "contentType",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "properties": {
                  "data": {
                    "properties": {
                      "acl": {
                        "type": "boolean"
                      },
                      "fields": {
                        "properties": {
                          "AWSAccessKeyId": {
                            "type": "string"
                          },
                          "key": {
                            "type": "string"
                          },
                          "policy": {
                            "type": "string"
                          },
                          "signature": {
                            "type": "string"
                          },
                          "x-amz-security-token": {
                            "type": "string"
                          }
                        },
                        "type": "object"
                      },
                      "finalUrl": {
                        "properties": {
                          "url": {
                            "type": "string"
                          }
                        },
                        "type": "object"
                      },
                      "url": {
                        "type": "string"
                      }
                    },
                    "type": "object"
                  }
                },
                "type": "object"
              }
            }
          },
          "required": false
        },
        "responses": {
          "default": {
            "description": "Native provider response"
          }
        },
        "servers": [
          {
            "description": "production",
            "url": "https://api.rippling.com/ats2_provisioning/api"
          },
          {
            "description": "sandbox",
            "url": "https://api.ripplingpreview.com/ats2_provisioning/api"
          }
        ],
        "summary": "Get Upload Url",
        "x-rippling-entitlements": [],
        "x-rippling-required-scopes": []
      }
    }
  }
}