{ "openapi": "3.0.1", "info": { "title": "ATS Jobs API", "description": "# Overview\n\nThe **ATS Jobs API** provides direct access to real-time job listings scraped from the following **13 Applicant Tracking Systems (ATS)**. Unlike aggregator APIs, we scrape directly from company career pages (`boards.greenhouse.io`, `jobs.lever.co`, etc.), giving you the most accurate and up-to-date job data available.\n\n## Key Benefits\n\n- **Direct Source Data**: Jobs scraped directly from company ATS platforms, not aggregators\n- **Zero Ghost Jobs**: We verify listings daily and detect when jobs are removed\n- **Structured Data**: Normalized job objects with rich location, compensation, and metadata\n- **High-Throughput Sync**: Feed endpoints support batches up to 10,000 jobs for efficient data ingestion\n- **Expiration Tracking**: Dedicated endpoint to track removed/filled positions\n\n## Supported ATS Platforms\n\nThe following 13 ATS platforms are **actively scraped daily** with the freshest data:\n\n| Platform | Typical Companies |\n|----------|-------------------|\n| `ashby` | High-growth startups (Notion, Plaid, Ramp) |\n| `bamboohr` | SMBs and mid-market companies |\n| `breezy` | Small businesses and agencies |\n| `greenhouse` | Enterprise and growth-stage (Airbnb, Stripe) |\n| `jazzhr` | SMBs across all industries |\n| `lever` | Tech startups and scale-ups |\n| `personio` | European companies |\n| `polymer` | Modern tech companies |\n| `recruitee` | SMBs and mid-market |\n| `rippling` | Tech-forward companies |\n| `smartrecruiters` | Enterprise global companies |\n| `workable` | SMBs and growth companies |\n| `workday` | Large enterprises (Fortune 500) |\n\n## Use Cases\n\n1. **Job Boards**: Build niche job boards with always-fresh data\n2. **AI Agents**: Power job search assistants with accurate listings\n3. **Market Research**: Analyze hiring trends by ATS platform, location, or industry\n4. **Salary Research**: Aggregate compensation data from structured job postings\n\n## Authentication\n\nThis API is hosted on RapidAPI. Include your API key in the `X-RapidAPI-Key` header with every request.", "termsOfService": "https://unlistd.xyz/terms", "contact": { "name": "API Support", "url": "https://unlistd.xyz/support", "email": "support@unlistd.xyz" }, "license": { "name": "Commercial", "url": "https://unlistd.xyz/license" }, "version": "1.0" }, "servers": [ { "url": "https://external-api.jobo.world", "description": "RapidAPI Production Gateway" } ], "tags": [ { "name": "Jobs", "description": "Search and filter job listings. Use these for user-facing search interfaces and discovery." }, { "name": "Sync", "description": "High-throughput endpoints for bulk ingestion and keeping your database in sync (feeds + expired IDs)." } ], "paths": { "/v1/jobs": { "get": { "tags": [ "Jobs" ], "summary": "Search Jobs", "description": "Search for jobs using query string parameters. This endpoint is optimized for lightweight, user-facing search interfaces.\n\n## When to Use\n\n- Building a search bar or filter UI\n- Quick lookups with simple criteria\n- Real-time search-as-you-type features\n\n## Search Behavior\n\n- **Text Search (`q`)**: Matches against job title, company name, and description using fuzzy matching\n- **Location Search (`location`)**: Matches against city, state/region, and country fields\n- **Multiple Sources**: Pass multiple `sources` parameters to filter by ATS platform\n\n## Pagination\n\nResults are paginated using `page` and `page_size`. Maximum 100 results per page. For bulk data retrieval, use the `/jobs/feed` endpoint instead.", "operationId": "Search Jobs", "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Full-text search query. Searches across job title, company name, and description. Supports fuzzy matching for typo tolerance.\n\n**Examples:**\n- `Software Engineer` - Find software engineering roles\n- `Product Manager` - Find PM roles\n- `React Developer` - Find React-specific roles", "schema": { "type": "string" }, "example": "Software Engineer" }, { "name": "location", "in": "query", "required": false, "description": "Location filter. Searches across city, state/region, and country fields. Supports partial matching.\n\n**Examples:**\n- `New York` - Jobs in New York area\n- `California` - Jobs in California state\n- `United States` - All US jobs\n- `London` - Jobs in London\n- `Remote` - Note: Use the `remote` parameter instead for remote filtering", "schema": { "type": "string" }, "example": "United States" }, { "name": "sources", "in": "query", "required": false, "description": "Filter by ATS platform(s) using a comma-separated string. Values are case-insensitive and whitespace is ignored.\n\n**Format:** `sources=greenhouse,lever`\n\n**Supported values:** `ashby`, `bamboohr`, `breezy`, `greenhouse`, `jazzhr`, `lever`, `personio`, `polymer`, `recruitee`, `rippling`, `smartrecruiters`, `workable`, `workday`", "schema": { "type": "string" }, "example": "" }, { "name": "remote", "in": "query", "required": false, "description": "Filter for remote work availability.\n\n- `true` - Only remote jobs\n- `false` - Only on-site/hybrid jobs\n- *omit* - All jobs regardless of remote status", "schema": { "type": "boolean" }, "example": null }, { "name": "posted_after", "in": "query", "required": false, "description": "Filter for jobs posted after this timestamp. Use ISO 8601 format with timezone (UTC recommended).\n\n**Examples:**\n- `2024-01-01T00:00:00Z` - Jobs posted in 2024\n- `2024-06-15T12:00:00Z` - Jobs posted after June 15, 2024 noon UTC", "schema": { "type": "string", "format": "date-time" }, "example": "2024-01-01T00:00:00Z" }, { "name": "page", "in": "query", "required": false, "description": "Page number for pagination. 1-indexed (first page is 1, not 0).", "schema": { "type": "integer", "format": "int32", "default": 1, "minimum": 1 }, "example": 1 }, { "name": "page_size", "in": "query", "required": false, "description": "Number of jobs to return per page. Maximum 100 to ensure reasonable response times.", "schema": { "type": "integer", "format": "int32", "default": 25, "minimum": 1, "maximum": 100 }, "example": 25 } ], "responses": { "200": { "description": "Successful search response containing matching jobs and pagination metadata.", "headers": { "X-Total-Count": { "description": "Total number of jobs matching the query across all pages.", "schema": { "type": "integer" }, "example": 1547 }, "X-Total-Pages": { "description": "Total number of pages available based on current page_size.", "schema": { "type": "integer" }, "example": 62 }, "X-Page": { "description": "Current page number.", "schema": { "type": "integer" }, "example": 1 }, "X-Page-Size": { "description": "Page size used for this request.", "schema": { "type": "integer" }, "example": 25 } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobSearchResponse" }, "example": { "jobs": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "title": "Senior Software Engineer", "company": { "id": "660e8400-e29b-41d4-a716-446655440001", "name": "Stripe" }, "description": "

We're looking for a Senior Software Engineer to help build the economic infrastructure for the internet. You'll work on distributed systems processing billions of API requests daily...

", "listing_url": "https://boards.greenhouse.io/stripe/jobs/5123456", "apply_url": "https://boards.greenhouse.io/stripe/jobs/5123456", "locations": [ { "location": "New York, NY, United States", "city": "New York", "state": "New York", "country": "United States", "latitude": 40.7128, "longitude": -74.0060 } ], "compensation": { "min": 185000, "max": 265000, "currency": "USD", "period": "Year", "raw_text": "$185,000 - $265,000 per year + equity", "is_estimated": false }, "employment_type": "full_time", "workplace_type": "hybrid", "experience_level": "senior", "source": "greenhouse", "source_id": "5123456", "created_at": "2024-12-10T10:30:00Z", "updated_at": "2024-12-15T08:00:00Z", "date_posted": "2024-12-10T00:00:00Z", "valid_through": null, "is_remote": false }, { "id": "660e8400-e29b-41d4-a716-446655440002", "title": "Staff Backend Engineer", "company": { "id": "770e8400-e29b-41d4-a716-446655440003", "name": "Ramp" }, "description": "

Join Ramp, the fastest-growing corporate card and spend management platform. We're building the future of finance automation...

", "listing_url": "https://jobs.ashbyhq.com/ramp/abc12345", "apply_url": "https://jobs.ashbyhq.com/ramp/abc12345", "locations": [ { "location": "Remote - United States", "city": null, "state": null, "country": "United States", "latitude": null, "longitude": null } ], "compensation": { "min": 200000, "max": 275000, "currency": "USD", "period": "Year", "raw_text": "$200K - $275K", "is_estimated": false }, "employment_type": "full_time", "workplace_type": "remote", "experience_level": "lead", "source": "ashby", "source_id": "abc12345", "created_at": "2024-12-12T14:00:00Z", "updated_at": "2024-12-12T14:00:00Z", "date_posted": "2024-12-12T00:00:00Z", "valid_through": null, "is_remote": true }, { "id": "770e8400-e29b-41d4-a716-446655440004", "title": "Product Manager, Growth", "company": { "id": "880e8400-e29b-41d4-a716-446655440005", "name": "Figma" }, "description": "

Figma is growing our Product team! We're looking for a Product Manager to drive growth initiatives and help millions of designers collaborate better...

", "listing_url": "https://jobs.lever.co/figma/def67890", "apply_url": "https://jobs.lever.co/figma/def67890", "locations": [ { "location": "San Francisco, CA, United States", "city": "San Francisco", "state": "California", "country": "United States", "latitude": 37.7749, "longitude": -122.4194 } ], "compensation": { "min": 160000, "max": 220000, "currency": "USD", "period": "Year", "raw_text": "$160,000 - $220,000 annually", "is_estimated": false }, "employment_type": "full_time", "workplace_type": "hybrid", "experience_level": "mid", "source": "lever", "source_id": "def67890", "created_at": "2024-12-08T09:00:00Z", "updated_at": "2024-12-14T11:00:00Z", "date_posted": "2024-12-08T00:00:00Z", "valid_through": null, "is_remote": false } ], "total": 48523, "page": 1, "page_size": 25, "total_pages": 1941 } } } }, "400": { "description": "Validation error. Check the `errors` object for details on which parameters failed validation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "errors": { "page_size": [ "The field page_size must be between 1 and 100." ] } } } } }, "500": { "description": "Internal server error. Please retry the request. If the issue persists, contact support.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.6.1", "title": "An error occurred while processing your request.", "status": 500, "detail": "An unexpected error occurred. Please try again later." } } } } } } }, "/v1/jobs/search": { "post": { "tags": [ "Jobs" ], "summary": "Advanced Job Search", "description": "Advanced search endpoint supporting multiple queries and locations in a single request. Use this when you need more complex search logic than the simple GET endpoint provides.\n\n## When to Use\n\n- Searching for multiple job titles simultaneously (e.g., 'Frontend' OR 'React' OR 'Vue')\n- Searching across multiple distinct locations\n- Building complex filter combinations\n- AI agents that need to cast a wider search net\n\n## Search Logic\n\n- **Queries**: Multiple queries use OR logic (matches any)\n- **Locations**: Multiple locations use OR logic (matches any)\n- **Sources**: Multiple sources use OR logic (matches any)\n- **Cross-field**: Different filter types use AND logic", "operationId": "Advanced Job Search", "requestBody": { "required": true, "description": "Search request body with filters and pagination.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobSearchRequest" }, "example": { "queries": [ "Software Engineer", "Backend Developer", "Full Stack" ], "locations": [ "United States" ], "sources": [ "greenhouse", "lever", "ashby", "workday" ], "is_remote": true, "posted_after": "2024-01-01T00:00:00Z", "page": 1, "page_size": 50 } } } }, "responses": { "200": { "description": "Successful search response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobSearchResponse" }, "example": { "jobs": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "title": "Backend Engineer", "company": { "id": "660e8400-e29b-41d4-a716-446655440002", "name": "StartupXYZ" }, "description": "

Join our engineering team...

", "listing_url": "https://jobs.lever.co/startupxyz/abc123", "apply_url": "https://jobs.lever.co/startupxyz/abc123", "locations": [ { "location": "Remote - United States", "city": null, "state": null, "country": "United States", "latitude": null, "longitude": null } ], "compensation": null, "employment_type": "full_time", "workplace_type": "remote", "experience_level": "mid", "source": "lever", "source_id": "abc123", "created_at": "2024-01-20T14:00:00Z", "updated_at": "2024-01-20T14:00:00Z", "date_posted": "2024-01-20T00:00:00Z", "valid_through": null, "is_remote": true } ], "total": 234, "page": 1, "page_size": 50, "total_pages": 5 } } } }, "400": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" } } } } } } }, "/v1/jobs/feed": { "post": { "tags": [ "Sync" ], "summary": "Jobs Feed (Sync)", "description": "**Primary endpoint for bulk data ingestion.** Use this to download large batches of jobs for populating or updating your database.\n\n## Cursor-Based Pagination\n\nThis endpoint uses cursor-based pagination for stable, efficient traversal of the job index. Unlike page-based pagination, cursors ensure you don't miss or duplicate records even if new jobs are added during your sync.\n\n## Sync Workflow\n\n1. **Initial Request**: Call without a cursor to start fresh\n2. **Process Jobs**: Store/update the `jobs` array in your database\n3. **Check HasMore**: If `hasMore` is `true`, continue to step 4\n4. **Next Batch**: Call again with `cursor` set to `nextCursor`\n5. **Repeat**: Continue until `hasMore` is `false`\n\n## Best Practices\n\n- **Batch Size**: Use 1,000-2,000 for optimal network performance\n- **Incremental Sync**: Use `postedAfter` with your last sync timestamp to get only new jobs\n- **Upsert Logic**: Use the `id` field as your primary key for upserts\n- **Error Handling**: Store the cursor after each successful batch so you can resume on failure", "operationId": "Jobs Feed (Sync)", "requestBody": { "required": true, "description": "Feed request with optional filters and pagination cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobFeedRequest" }, "examples": { "us_jobs_full_sync": { "summary": "Full sync - All US jobs (recommended start)", "description": "Download all jobs in the United States. This returns the most data - typically 40,000+ jobs.", "value": { "batch_size": 500, "locations": [ { "country": "United States" } ] } }, "all_jobs_full_sync": { "summary": "Full sync - All jobs globally", "description": "Download all jobs from all sources and locations. Returns 100,000+ jobs.", "value": { "batch_size": 500 } }, "continue_sync": { "summary": "Continue sync with cursor", "description": "Subsequent request using cursor from previous response", "value": { "batch_size": 500, "cursor": "eyJzb3J0IjpbMTcwNTMxMjAwMDAwMF0sInNlYXJjaF9hZnRlciI6WyI1NTBlODQwMC1lMjliLTQxZDQtYTcxNi00NDY2NTU0NDAwMDAiXX0=" } }, "startup_jobs_sync": { "summary": "Startup jobs only", "description": "Sync jobs from startup-focused ATS platforms (Ashby, Lever, Greenhouse)", "value": { "batch_size": 500, "sources": [ "ashby", "lever", "greenhouse" ] } }, "remote_us_jobs": { "summary": "Remote jobs in US", "description": "Remote-only jobs available in the United States", "value": { "batch_size": 500, "locations": [ { "country": "United States" } ], "is_remote": true } }, "incremental_sync": { "summary": "Incremental sync (new jobs only)", "description": "Get only jobs posted since your last sync. Run daily to stay updated.", "value": { "batch_size": 500, "posted_after": "2024-12-17T00:00:00Z" } } } } } }, "responses": { "200": { "description": "Batch of jobs with pagination cursor.", "headers": { "X-Has-More": { "description": "Indicates if more jobs are available. Mirrors the `has_more` field in the response body.", "schema": { "type": "boolean" }, "example": true } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobFeedResponse" }, "example": { "jobs": [ { "id": "550e8400-e29b-41d4-a716-446655440000", "title": "Product Manager", "company": { "id": "770e8400-e29b-41d4-a716-446655440003", "name": "InnovateCo" }, "description": "

Lead product strategy...

", "listing_url": "https://jobs.ashbyhq.com/innovateco/pm-123", "apply_url": "https://jobs.ashbyhq.com/innovateco/pm-123", "locations": [ { "location": "New York, NY", "city": "New York", "state": "New York", "country": "United States", "latitude": 40.7128, "longitude": -74.0060 } ], "compensation": { "min": 120000, "max": 160000, "currency": "USD", "period": "Year", "raw_text": "$120K - $160K", "is_estimated": false }, "employment_type": "full_time", "workplace_type": "onsite", "experience_level": "senior", "source": "ashby", "source_id": "pm-123", "created_at": "2024-01-18T09:00:00Z", "updated_at": "2024-01-18T09:00:00Z", "date_posted": "2024-01-18T00:00:00Z", "valid_through": null, "is_remote": false } ], "next_cursor": "eyJzb3J0IjpbMTcwNTU3MTYwMDAwMF0sInNlYXJjaF9hZnRlciI6WyI1NTBlODQwMC1lMjliLTQxZDQtYTcxNi00NDY2NTU0NDAwMDAiXX0=", "has_more": true } } } }, "400": { "description": "Validation error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationProblemDetails" }, "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "Validation error", "status": 400, "errors": { "batch_size": [ "The field batch_size must be between 1 and 10000." ] } } } } } } } }, "/v1/jobs/expired": { "get": { "tags": [ "Sync" ], "summary": "Expired Jobs Feed", "description": "Returns a stream of Job IDs that have been detected as closed, filled, or removed from the source career site since a specified date.", "operationId": "Expired Jobs Feed", "parameters": [ { "name": "expired_since", "in": "query", "required": true, "description": "**Required.** Only return jobs that expired on or after this UTC timestamp. Use ISO 8601 format. Maximum lookback is 7 days from now.", "schema": { "type": "string", "format": "date-time" }, "example": "2025-12-18T00:00:00Z" }, { "name": "cursor", "in": "query", "description": "Pagination cursor from the previous response's `next_cursor`. Omit on first request.", "schema": { "type": "string" } }, { "name": "batch_size", "in": "query", "description": "Number of expired job IDs to return per batch. Since these are just UUIDs (not full job objects), you can use larger batch sizes.", "schema": { "type": "integer", "format": "int32", "default": 1000, "minimum": 1, "maximum": 10000 } } ], "responses": { "200": { "description": "Batch of expired job IDs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpiredJobIdsFeedResponse" } } } } } } } }, "components": { "schemas": { "Job": { "type": "object", "description": "A job listing with all available metadata. This is the core data object returned by search and feed endpoints.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Unique identifier for this job in our system. Use this as your primary key for storage and deduplication." }, "title": { "type": "string", "description": "Job title exactly as it appears on the company's career site." }, "company": { "$ref": "#/components/schemas/JobCompany" }, "description": { "type": "string", "description": "Full job description, typically in HTML format. May include formatting, lists, and links." }, "listing_url": { "type": "string", "format": "uri", "description": "Canonical URL to the job listing page." }, "apply_url": { "type": "string", "format": "uri", "description": "Direct URL to the job application page on the company's ATS. This is NOT a redirect through an aggregator - it goes directly to the source." }, "locations": { "type": "array", "description": "List of work locations for this job. A job may have multiple locations (e.g., 'San Francisco OR New York').", "items": { "$ref": "#/components/schemas/JobLocation" } }, "compensation": { "allOf": [ { "$ref": "#/components/schemas/JobCompensation" } ], "nullable": true, "description": "Salary/compensation information if available. Many jobs don't include compensation data, in which case this will be null." }, "employment_type": { "$ref": "#/components/schemas/EmploymentType" }, "workplace_type": { "$ref": "#/components/schemas/WorkplaceType" }, "experience_level": { "$ref": "#/components/schemas/ExperienceLevel" }, "source": { "type": "string", "description": "The ATS platform identifier where this job was scraped from.", "enum": [ "ashby", "bamboohr", "breezy", "greenhouse", "jazzhr", "lever", "personio", "polymer", "recruitee", "rippling", "smartrecruiters", "workable", "workday" ] }, "source_id": { "type": "string", "description": "The job's internal ID within the source ATS. Combined with `source`, this provides a secondary unique identifier." }, "created_at": { "type": "string", "format": "date-time", "description": "Timestamp when we first discovered and indexed this job (UTC)." }, "updated_at": { "type": "string", "format": "date-time", "description": "Timestamp of our last update to this job record (UTC)." }, "date_posted": { "type": "string", "format": "date-time", "nullable": true, "description": "The date the job was posted on the career site, if provided by the ATS. May be null if not available." }, "valid_through": { "type": "string", "format": "date-time", "nullable": true, "description": "Expiration date for the job posting, if provided by the ATS. Usually null - use the /jobs/expired endpoint to track closed jobs." }, "is_remote": { "type": "boolean", "description": "True if the job is explicitly marked as remote-friendly. False does not necessarily mean on-site only - check `workplace_type` for more detail." } }, "example": { "id": "550e8400-e29b-41d4-a716-446655440000", "title": "Senior Software Engineer", "company": { "id": "660e8400-e29b-41d4-a716-446655440001", "name": "TechCorp Inc" }, "description": "

We are looking for a Senior Software Engineer...

", "listing_url": "https://boards.greenhouse.io/techcorp/jobs/123456", "apply_url": "https://boards.greenhouse.io/techcorp/jobs/123456", "locations": [ { "location": "San Francisco, CA, United States", "city": "San Francisco", "state": "California", "country": "United States", "latitude": 37.7749, "longitude": -122.4194 } ], "compensation": { "min": 150000, "max": 200000, "currency": "USD", "period": "Year", "raw_text": "$150,000 - $200,000 per year", "is_estimated": false }, "employment_type": "full_time", "workplace_type": "hybrid", "experience_level": "senior", "source": "greenhouse", "source_id": "gh_123456", "created_at": "2024-01-15T10:30:00Z", "updated_at": "2024-01-16T08:00:00Z", "date_posted": "2024-01-15T00:00:00Z", "valid_through": null, "is_remote": false } }, "JobCompany": { "type": "object", "description": "Company information for a job.", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } } }, "JobLocation": { "type": "object", "description": "Structured location information for a job posting.", "properties": { "location": { "type": "string", "nullable": true, "description": "Full location string as displayed on the career site (e.g., 'San Francisco, CA, United States')." }, "city": { "type": "string", "nullable": true, "description": "City name, if we could parse it from the location string." }, "state": { "type": "string", "nullable": true, "description": "State, province, or region name." }, "country": { "type": "string", "nullable": true, "description": "Country name." }, "latitude": { "type": "number", "format": "double", "nullable": true, "description": "Geographic latitude coordinate, if available." }, "longitude": { "type": "number", "format": "double", "nullable": true, "description": "Geographic longitude coordinate, if available." } }, "example": { "location": "San Francisco, CA, United States", "city": "San Francisco", "state": "California", "country": "United States", "latitude": 37.7749, "longitude": -122.4194 } }, "JobCompensation": { "type": "object", "description": "Salary and compensation information. All fields are optional as different job postings include varying levels of detail.", "properties": { "min": { "type": "number", "format": "double", "nullable": true, "description": "Minimum salary/rate in the compensation range." }, "max": { "type": "number", "format": "double", "nullable": true, "description": "Maximum salary/rate in the compensation range." }, "currency": { "type": "string", "nullable": true, "description": "ISO 4217 currency code (e.g., 'USD', 'EUR', 'GBP')." }, "period": { "$ref": "#/components/schemas/CompensationPeriod" }, "raw_text": { "type": "string", "nullable": true, "description": "Original compensation text as it appeared in the job posting. Useful when structured parsing wasn't possible." }, "is_estimated": { "type": "boolean", "description": "True if the compensation range was estimated (e.g., from job title/location data) rather than explicitly stated in the posting." } }, "example": { "min": 150000, "max": 200000, "currency": "USD", "period": "Year", "raw_text": "$150,000 - $200,000 per year", "is_estimated": false } }, "JobSearchRequest": { "type": "object", "description": "Request body for advanced job search.", "properties": { "queries": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of search queries (OR logic). Each query searches across title, company, and description." }, "locations": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of location terms to filter by (OR logic)." }, "sources": { "type": "array", "items": { "type": "string", "enum": [ "ashby", "bamboohr", "breezy", "greenhouse", "jazzhr", "lever", "personio", "polymer", "recruitee", "rippling", "smartrecruiters", "workable", "workday" ] }, "nullable": true, "description": "List of ATS source identifiers to include (OR logic). Supported values: ashby, bamboohr, breezy, greenhouse, jazzhr, lever, personio, polymer, recruitee, rippling, smartrecruiters, workable, workday" }, "is_remote": { "type": "boolean", "nullable": true, "description": "Filter for remote jobs. True = remote only, false = non-remote only, null = all." }, "posted_after": { "type": "string", "format": "date-time", "nullable": true, "description": "Only return jobs posted after this timestamp (ISO 8601 UTC)." }, "page": { "type": "integer", "format": "int32", "default": 1, "minimum": 1, "description": "Page number (1-indexed)." }, "page_size": { "type": "integer", "format": "int32", "default": 25, "minimum": 1, "maximum": 100, "description": "Results per page (max 100)." } }, "example": { "queries": [ "Software Engineer", "Backend Developer", "Full Stack Engineer" ], "locations": [ "United States" ], "sources": null, "is_remote": null, "posted_after": "2024-12-01T00:00:00Z", "page": 1, "page_size": 100 } }, "JobSearchResponse": { "type": "object", "description": "Paginated search results.", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/Job" }, "description": "Array of matching jobs for the current page." }, "total": { "type": "integer", "format": "int64", "description": "Total number of jobs matching the query across all pages." }, "page": { "type": "integer", "format": "int32", "description": "Current page number." }, "page_size": { "type": "integer", "format": "int32", "description": "Number of results per page." }, "total_pages": { "type": "integer", "format": "int32", "description": "Total number of pages available." } } }, "JobFeedRequest": { "type": "object", "description": "Request body for the feed endpoint.", "properties": { "batch_size": { "type": "integer", "format": "int32", "default": 500, "minimum": 1, "maximum": 1000, "description": "Number of jobs to return per batch. Recommended: 500-1000 for optimal performance." }, "cursor": { "type": "string", "nullable": true, "description": "Pagination cursor from the previous response's `next_cursor`. Omit for the first request." }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/LocationFilter" }, "nullable": true, "description": "Structured location filters. Job matches if it matches ANY provided location." }, "sources": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "ATS source identifiers to include." }, "is_remote": { "type": "boolean", "nullable": true, "description": "Filter for remote jobs." }, "posted_after": { "type": "string", "format": "date-time", "nullable": true, "description": "Only return jobs posted after this timestamp. Use for incremental syncs." } }, "example": { "batch_size": 500, "locations": [ { "country": "United States" } ], "sources": null, "is_remote": null, "posted_after": null } }, "LocationFilter": { "type": "object", "description": "Structured location filter for feed requests. More precise than text-based location search.", "properties": { "country": { "type": "string", "nullable": true, "description": "Country name to filter by." }, "region": { "type": "string", "nullable": true, "description": "State, province, or region to filter by." }, "city": { "type": "string", "nullable": true, "description": "City to filter by." } }, "example": { "country": "United States", "region": null, "city": null } }, "JobFeedResponse": { "type": "object", "description": "Batch of jobs with pagination cursor.", "properties": { "jobs": { "type": "array", "items": { "$ref": "#/components/schemas/Job" }, "description": "Array of jobs in this batch." }, "next_cursor": { "type": "string", "nullable": true, "description": "Cursor for fetching the next batch. Pass this value as the `cursor` parameter in your next request." }, "has_more": { "type": "boolean", "description": "True if more jobs are available. When false, you've reached the end of the feed." } } }, "ExpiredJobIdsFeedResponse": { "type": "object", "description": "Batch of expired job IDs.", "properties": { "job_ids": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Array of job IDs that have been detected as expired/closed." }, "next_cursor": { "type": "string", "nullable": true, "description": "Cursor for fetching the next batch of expired IDs." }, "has_more": { "type": "boolean", "description": "True if more expired IDs are available." } }, "example": { "job_ids": [ "550e8400-e29b-41d4-a716-446655440000", "660e8400-e29b-41d4-a716-446655440001" ], "next_cursor": null, "has_more": false } }, "EmploymentType": { "type": "string", "description": "The type of employment offered.", "enum": [ "NotSpecified", "FullTime", "PartTime", "Contract", "Temporary", "Internship", "Volunteer", "Other" ], "example": "FullTime" }, "WorkplaceType": { "type": "string", "description": "Where the work is performed.", "enum": [ "NotSpecified", "Onsite", "Hybrid", "Remote" ], "example": "Hybrid" }, "ExperienceLevel": { "type": "string", "description": "Required experience level for the role.", "enum": [ "NotSpecified", "Internship", "Entry", "Mid", "Senior", "Lead", "Manager", "Director", "Executive" ], "example": "Senior" }, "CompensationPeriod": { "type": "string", "description": "Time period for the compensation amount.", "enum": [ "NotSpecified", "Hour", "Day", "Week", "Month", "Year" ], "example": "Year" }, "ProblemDetails": { "type": "object", "description": "RFC 7807 Problem Details for HTTP APIs.", "properties": { "type": { "type": "string", "description": "A URI reference that identifies the problem type." }, "title": { "type": "string", "description": "A short, human-readable summary of the problem type." }, "status": { "type": "integer", "format": "int32", "description": "The HTTP status code." }, "detail": { "type": "string", "description": "A human-readable explanation specific to this occurrence of the problem." }, "instance": { "type": "string", "description": "A URI reference that identifies the specific occurrence of the problem." } } }, "ValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } }, "description": "Dictionary of validation errors. Keys are field names, values are arrays of error messages." } } } ], "example": { "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "errors": { "page_size": [ "The field page_size must be between 1 and 100." ] } } } }, "securitySchemes": {} }, "security": [] }