Workday Jobs API Capability

List job facets

Return available Workday job-search facets and counts.

Capability ID workday.jobs.facets

Cost From $1.25 per 1,000 requests · 1 credit

Maximum runtime 30 seconds

# List job facets

Return available Workday job-search facets and counts.

- Platform: [Workday Jobs](https://docs.upscrape.com/docs/platforms/workday)
- Capability ID: `workday.jobs.facets`
- Cost: 1 credit per request
- Maximum runtime: 30 seconds
- Execute endpoint: `POST https://data.upscrape.com/execute`

## Request

Use the exact public capability ID in the shared execute envelope.

```bash
curl --request POST \
  --url https://data.upscrape.com/execute \
  --header "Authorization: Bearer $UPSCRAPE_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Prefer: wait=30" \
  --data '{
  "input": {
    "applied_facets": {
      "jobFamilyGroup": [
        "ace7a3d23b7e01a0544279031a0ec85c"
      ],
      "locations": [
        "1e4a4eb3adf1011246675c76bf81f8ce"
      ],
      "timeType": [
        "dc193d6170de10860883d9bf7c0e01a9"
      ],
      "workerSubType": [
        "dc8bf79476611087dfde9c6b065bae76"
      ]
    },
    "board_url": "https://intel.wd1.myworkdayjobs.com/en-US/External",
    "query": "software"
  },
  "capability": "workday.jobs.facets"
}'
```

## Input


| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `applied_facets` | `object` | No |  |
| `board_url` | `string` | Yes | Public URL of the board. |
| `query` | `string` | No | Search query. |

### Example input

```json
{
  "applied_facets": {
    "jobFamilyGroup": [
      "ace7a3d23b7e01a0544279031a0ec85c"
    ],
    "locations": [
      "1e4a4eb3adf1011246675c76bf81f8ce"
    ],
    "timeType": [
      "dc193d6170de10860883d9bf7c0e01a9"
    ],
    "workerSubType": [
      "dc8bf79476611087dfde9c6b065bae76"
    ]
  },
  "board_url": "https://intel.wd1.myworkdayjobs.com/en-US/External",
  "query": "software"
}
```

## Response

Successful output is returned in `results[0].data`.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

No example output is available for this capability.


## Execution behavior

A `200` response completed inline. A `202` response was queued; poll `GET /jobs/{id}` until the job reaches `completed` or `failed`. Use an `Idempotency-Key` when retrying must not create a duplicate logical job.

## Related documentation

- [Authentication](https://docs.upscrape.com/docs/api/authentication)
- [Jobs and results](https://docs.upscrape.com/docs/api/jobs)
- [Errors and retries](https://docs.upscrape.com/docs/api/errors)
- [Idempotency](https://docs.upscrape.com/docs/api/idempotency)

POST /execute Shared execution endpoint

Input parameters

applied_facets object optional

Example

{"jobFamilyGroup":["ace7a3d23b7e01a0544279031a0ec85c"],"locations":["1e4a4eb3adf1011246675c76bf81f8ce"],"timeType":["dc193d6170de10860883d9bf7c0e01a9"],"workerSubType":["dc8bf79476611087dfde9c6b065bae76"]}

board_url string required

Public URL of the board.

Example https://intel.wd1.myworkdayjobs.com/en-US/External

query string optional

Search query.

Example software

Response

Successful output is returned in results[0].data.

Raw platform output is intentionally open-ended and may evolve with the upstream source.

No example output is available for this capability yet.

Execution behavior

A 200 response completed inline. A 202 response was queued; poll GET /jobs/:id until the job reaches completed or failed.

curl --request POST \ --url https://data.upscrape.com/execute \ --header "Authorization: Bearer $UPSCRAPE_API_KEY" \ --header "Content-Type: application/json" \ --header "Prefer: wait=30" \ --data '{ "input": { "applied_facets": { "jobFamilyGroup": [ "ace7a3d23b7e01a0544279031a0ec85c" ], "locations": [ "1e4a4eb3adf1011246675c76bf81f8ce" ], "timeType": [ "dc193d6170de10860883d9bf7c0e01a9" ], "workerSubType": [ "dc8bf79476611087dfde9c6b065bae76" ] }, "board_url": "https://intel.wd1.myworkdayjobs.com/en-US/External", "query": "software" }, "capability": "workday.jobs.facets" }'

import json import os import requests payload = json.loads(r'''{ "input": { "applied_facets": { "jobFamilyGroup": [ "ace7a3d23b7e01a0544279031a0ec85c" ], "locations": [ "1e4a4eb3adf1011246675c76bf81f8ce" ], "timeType": [ "dc193d6170de10860883d9bf7c0e01a9" ], "workerSubType": [ "dc8bf79476611087dfde9c6b065bae76" ] }, "board_url": "https://intel.wd1.myworkdayjobs.com/en-US/External", "query": "software" }, "capability": "workday.jobs.facets" }''') response = requests.post( "https://data.upscrape.com/execute", headers={ "Authorization": f"Bearer {os.environ['UPSCRAPE_API_KEY']}", "Content-Type": "application/json", "Prefer": "wait=30", }, json=payload, ) response.raise_for_status() print(json.dumps(response.json(), indent=2))