Appearance
Jobs endpoints
Reference for the /job endpoint family in API V2.
What is a job?
A job is a scheduled data collection task that fetches content from an external platform on a defined frequency and ingests it into one or more projects.
Each job has:
- a type identifying the source platform
- a frequency defining how often it runs (in seconds)
- an active flag controlling whether it is scheduled
- optional search parameters that drive what content is collected
- associations to one or more projects that receive the collected posts
Supported platforms
The type field identifies the source. Supported codes include:
| Code | Platform |
|---|---|
wh | Webhose / Webz.io (news and blogs) |
tw | Twitter / X |
ig | Instagram (via Netfeedr) |
nf | Facebook (via Netfeedr) |
nc | Facebook (via CrowdTangle) |
tt | TikTok |
tg | Telegram |
yt | YouTube |
bsky | Bluesky |
in |
Authentication
Authentication is required. See Authentication.
Permissions
Permissions are tier-based and vary by endpoint.
| Endpoint | Minimum tier |
|---|---|
job/new, job/edit, job/delete | 2 (Superuser) |
job/on, job/off | 2 (Superuser) |
job/all, job/single, job/preview | 4 (User) |
Endpoints
- job/all — list all jobs
- job/single — get one job by id
- job/new — create a job
- job/edit — update a job
- job/delete — delete a job
- job/on — activate a job
- job/off — deactivate a job
- job/preview — run a dry-run fetch without saving results
Notes
- Activating or deactivating a job does not affect already-collected posts.
job/previewis useful for validating search parameters before a job is saved or activated.- This section documents only V2 paths (
/v2/...).