v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

referralCampaigns

retrieve a list of Hire openings with targeting

get/api/servicereferral/processes/referralCampaigns/{companyUuid}/openings

Path parameters

companyUuidstring required

company UUID

Query parameters

workerUuidstring required

worker UUID

brandUuidstring

brand UUID

pageinteger

The page of entities to retrieve

searchstring

Name of the location to search

Response

status success

Example response

{
  "data": {
    "openings": [
      {
        "title": "Example Opening Title",
        "apply_url": "https://fountain.com/apply/account-name/opening/opening-title",
        "id": "186055b7-c55d-4fca-a843-4c588334e157",
        "location": {
          "name": "Example Location Name",
          "id": "fc81f284-4155-4b8f-9cc3-e29f4aef6a4f"
        },
        "incentives": [
          {
            "rewardType": "worker",
            "currency": "USD",
            "cashValue": 100,
            "payoutCondition": "daysAfterHire"
          }
        ]
      }
    ]
  }
}