{ "overlay": "1.0.0", "info": { "title": "JobsPipe API examples and tags", "version": "1.0.0" }, "extends": "https://jobspipe.dev/openapi.base.json", "actions": [ { "target": "$", "description": "Declare the API tags.", "update": { "tags": [ { "name": "Jobs", "description": "Search and read job postings, and the companies hiring." }, { "name": "Companies", "description": "Company records, suggestions and technographic search." }, { "name": "Technologies", "description": "The technologies companies hire for, and who uses each one." }, { "name": "Stack", "description": "Detect the technologies a website runs." }, { "name": "Monitors", "description": "Follow records and be told by webhook when they change." }, { "name": "Labour Market Insights", "description": "Aggregates over the postings, such as salary benchmarks." }, { "name": "Layoffs", "description": "US WARN Act layoff and closure notices, with the company each names." }, { "name": "Contacts", "description": "Find work emails, personal emails and phone numbers for people." }, { "name": "Live", "description": "Read a board or search a source live, without waiting for a crawl." }, { "name": "Account", "description": "The calling account, its credits, and feedback on the data." }, { "name": "Billing", "description": "Buy a package or credits." }, { "name": "Sandbox", "description": "Keyless sample responses for trying the API." } ] } }, { "target": "$.paths['/v1/jobs/search'].post", "description": "searchJobs", "update": { "tags": [ "Jobs" ], "requestBody": { "content": { "application/json": { "example": { "job_title_or": [ "director of finance", "finance director" ], "job_country_code_or": [ "US" ], "posted_at_max_age_days": 30, "limit": 25 } } } }, "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "total_results": 412, "truncated_results": 1, "next_cursor": "eyJvIjoyNX0", "credits_charged": 1, "jobs_already_paid": 0, "credits_remaining": 9874, "credits_allowance": 10000 }, "data": [ { "id": "6caa6709-30c2-436c-85a1-4d16f711393f", "job_title": "Director of Finance", "company": "broccoli", "company_domain": "broccoli.ai", "url": "https://jobs.ashbyhq.com/broccoli/6caa6709-30c2-436c-85a1-4d16f711393f", "source_url": "https://jobs.ashbyhq.com/broccoli/6caa6709-30c2-436c-85a1-4d16f711393f", "final_url": null, "date_posted": "2026-07-27T17:27:31.444+00:00", "discovered_at": "2026-08-03T18:16:04.619757+00:00", "status": "active", "closed_at": null, "closed_reason": null, "location": "San Francisco", "country": "United States", "country_code": "US", "country_codes": [ "US" ], "cities": [ "San Francisco" ], "state_code": "California", "remote": false, "seniority": "director", "employment_statuses": [ "full_time" ], "technology_slugs": [ "excel", "sql" ], "keyword_slugs": [ "accounting", "financial-modeling", "excel", "sql" ], "occupation_code": "1211", "occupation_label": "Finance Managers", "employer_type": "employer", "has_blurred_data": false, "sources": [ { "provider": "ashby", "url": "https://jobs.ashbyhq.com/broccoli/6caa6709-30c2-436c-85a1-4d16f711393f", "seen_at": "2026-08-03T18:16:04.619757+00:00" } ] } ] } } } } } } }, { "target": "$.paths['/v1/jobs/export'].post", "description": "exportJobs", "update": { "requestBody": { "content": { "application/json": { "example": { "job_title_or": [ "data engineer" ], "job_country_code_or": [ "US" ] } } } } } }, { "target": "$.paths['/v1/jobs/export/estimate'].post", "description": "estimateJobsExport", "update": { "requestBody": { "content": { "application/json": { "example": { "job_title_or": [ "data engineer" ], "job_country_code_or": [ "US" ] } } } } } }, { "target": "$.paths['/v1/jobs/agentic-search'].post", "description": "agenticSearchJobs", "update": { "tags": [ "Jobs" ], "requestBody": { "content": { "application/json": { "example": { "query": "finance leaders at Series B fintechs in the Bay Area", "limit": 10 } } } }, "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "total_results": null, "truncated_results": 1, "next_cursor": null, "credits_charged": 1, "jobs_already_paid": 0 }, "data": [ { "id": "6caa6709-30c2-436c-85a1-4d16f711393f", "job_title": "Director of Finance", "company": "broccoli", "company_domain": "broccoli.ai", "url": "https://jobs.ashbyhq.com/broccoli/6caa6709-30c2-436c-85a1-4d16f711393f", "source_url": "https://jobs.ashbyhq.com/broccoli/6caa6709-30c2-436c-85a1-4d16f711393f", "final_url": null, "date_posted": "2026-07-27T17:27:31.444+00:00", "discovered_at": "2026-08-03T18:16:04.619757+00:00", "status": "active", "closed_at": null, "closed_reason": null, "location": "San Francisco", "country": "United States", "country_code": "US", "country_codes": [ "US" ], "cities": [ "San Francisco" ], "state_code": "California", "remote": false, "seniority": "director", "employment_statuses": [ "full_time" ], "technology_slugs": [ "excel", "sql" ], "keyword_slugs": [ "accounting", "financial-modeling", "excel", "sql" ], "occupation_code": "1211", "occupation_label": "Finance Managers", "employer_type": "employer", "has_blurred_data": false, "sources": [ { "provider": "ashby", "url": "https://jobs.ashbyhq.com/broccoli/6caa6709-30c2-436c-85a1-4d16f711393f", "seen_at": "2026-08-03T18:16:04.619757+00:00" } ], "relevance": 0.82 } ] } } } } } } }, { "target": "$.paths['/v1/stack/scan'].post", "description": "scanStack", "update": { "tags": [ "Stack" ], "requestBody": { "content": { "application/json": { "example": { "domain": "google.com", "mode": "auto" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "domain": "google.com", "scanned_at": "2026-10-07T11:58:03.000Z", "http_status": 200, "detected": [ { "slug": "google-analytics", "name": "Google Analytics", "categories": [ "Analytics" ], "confidence": 100, "version": "GA4", "signals": [ { "kind": "script", "match": "googletagmanager.com/gtag/js" } ], "pricing": [ "freemium" ], "saas": true, "oss": false } ] } } } } } } }, { "target": "$.paths['/v1/enrich/email'].post", "description": "enrichEmail", "update": { "requestBody": { "content": { "application/json": { "example": { "items": [ { "linkedin_url": "https://www.linkedin.com/in/jane-doe" }, { "full_name": "Sam Lee", "domain": "acme.com" } ] } } } }, "responses": { "200": { "content": { "application/json": { "example": { "results": [ { "index": 0, "status": "enriched", "type": "work", "value": "jane.doe@northwind.com", "credits": 23 }, { "index": 1, "status": "not_found", "type": "work", "value": null, "credits": 0 } ], "found": 1, "credits_charged": 23 } } } } } } }, { "target": "$.paths['/v1/enrich/phone'].post", "description": "enrichPhone", "update": { "requestBody": { "content": { "application/json": { "example": { "items": [ { "linkedin_url": "https://www.linkedin.com/in/jane-doe" } ] } } } }, "responses": { "200": { "content": { "application/json": { "example": { "results": [ { "index": 0, "status": "cached", "type": "phone", "value": "+1 415 555 0142", "credits": 0 } ], "found": 1, "credits_charged": 0 } } } } } } }, { "target": "$.paths['/v1/companies/{key}'].get", "description": "getCompany", "update": { "tags": [ "Companies" ], "responses": { "200": { "content": { "application/json": { "example": { "key": "9002", "name": "Google", "domain": "google.com", "url": "https://google.com", "logo": null, "employee_count": 190000, "linkedin_url": "https://www.linkedin.com/company/google", "description": null, "location": { "street": null, "city": "Mountain View", "region": "California", "postal_code": null, "country": "US" }, "founded": "1998" } } } } } } }, { "target": "$.paths['/v1/companies/suggest'].get", "description": "suggestCompanies", "update": { "responses": { "200": { "content": { "application/json": { "example": { "query": "goog", "candidates": [ { "key": "9002", "name": "Google", "domain": "google.com", "jobs": 9540, "hq_country": "US", "verified": true } ] } } } } } } }, { "target": "$.paths['/v1/companies/search'].post", "description": "searchCompaniesByTechnology", "update": { "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "total_companies": 1840, "truncated_companies": 1, "credits_charged": 1, "companies_already_paid": 0, "as_of": "2026-10-24" }, "data": [ { "id": "3837186692681720328", "name": "Google", "domain": "google.com", "country_code": "US", "employee_count": 190000, "num_jobs": 9540, "num_jobs_found": 214, "technology_slugs": [ "snowflake" ] } ] } } } } } } }, { "target": "$.paths['/v1/companies/{key}/technologies'].get", "description": "getCompanyTechnologies", "update": { "responses": { "200": { "content": { "application/json": { "example": { "as_of": "2026-10-07", "company": { "id": "3837186692681720328", "name": "Google", "domain": "google.com", "url": "https://google.com", "logo": null, "linkedin_url": null }, "num_jobs": 9540, "num_technologies": 1, "data": [ { "technology": { "slug": "python", "name": "Python", "category": "Programming languages", "category_slug": null, "parent_category": "Programming languages", "kind": null, "logo": null }, "confidence": "high", "tier": "confirmed", "jobs": 2140, "jobs_last_7_days": 238, "jobs_last_30_days": 856, "first_date_found": "2026-08-03", "last_date_found": "2026-10-06", "recency": "active", "share": 0.22 } ] } } } } } } }, { "target": "$.paths['/v1/technologies'].get", "description": "listTechnologies", "update": { "responses": { "200": { "content": { "application/json": { "example": { "as_of": "2026-10-24", "metadata": { "total_results": 4210, "limit": 1, "page": 1 }, "data": [ { "technology": { "slug": "snowflake", "name": "Snowflake", "category": "Data warehouses", "category_slug": "data-warehouses", "parent_category": "Data", "kind": "software", "logo": null }, "companies": 1840, "jobs": 6120, "first_date_found": "2026-06-02", "last_date_found": "2026-10-24" } ] } } } } } } }, { "target": "$.paths['/v1/technologies/resolve'].post", "description": "resolveTechnologies", "update": { "responses": { "200": { "content": { "application/json": { "example": { "as_of": "2026-10-24", "data": [ { "name": "okta.com", "slug": "okta", "technology_name": "Okta", "match": "domain", "companies": 2310, "jobs": 4870 } ] } } } } } } }, { "target": "$.paths['/v1/technologies/{slug}'].get", "description": "getTechnology", "update": { "responses": { "200": { "content": { "application/json": { "example": { "as_of": "2026-10-24", "technology": { "slug": "snowflake", "name": "Snowflake", "category": "Data warehouses", "category_slug": "data-warehouses", "parent_category": "Data", "kind": "software", "logo": null }, "companies": 1840, "jobs": 6120, "first_date_found": "2026-06-02", "last_date_found": "2026-10-24", "companies_by_tier": { "confirmed": 910, "likely": 640, "mentioned": 290 }, "top_countries": [ "US", "GB", "IN" ], "top_companies": [ { "id": "3837186692681720328", "name": "Google", "domain": "google.com", "url": "https://google.com", "logo": null, "tier": "confirmed", "confidence": "high", "jobs": 214, "first_date_found": "2026-08-03", "last_date_found": "2026-10-06" } ], "monthly_adoption": [ { "month": "2026-09", "companies": 1210, "active_companies": 1102, "jobs": 1980 } ] } } } } } } }, { "target": "$.paths['/v1/account'].get", "description": "getAccount", "update": { "tags": [ "Account" ], "responses": { "200": { "content": { "application/json": { "example": { "user_id": "usr_8f2c1d", "email": "dev@example.com", "name": "Ada Developer", "auth_type": "api_key", "plan": "builder", "month": "2026-10", "monthly_credits": 10000, "credits_used": 126, "credits_remaining": 9874, "extra_credits": 0, "max_results_per_request": 100, "requests_per_second": 5 } } } } } } }, { "target": "$.paths['/v1/feedback'].post", "description": "submitFeedback", "update": { "tags": [ "Account" ], "requestBody": { "content": { "application/json": { "example": { "category": "data_quality", "message": "This posting is closed on the company's site.", "job_ids": [ "4450909183" ] } } } }, "responses": { "201": { "content": { "application/json": { "example": { "id": "5d1f0c7e-2b8a-4c3e-9f61-0a7d3e2b9c48", "received_at": "2026-10-25T10:00:00.000Z", "note": "Thanks. A person reads every report." } } } } } } }, { "target": "$.paths['/v1/billing/checkout'].post", "description": "createBillingCheckout", "update": { "tags": [ "Billing" ] } }, { "target": "$.paths['/v1/insights/salary/benchmark'].post", "description": "insightsSalaryBenchmark", "update": { "requestBody": { "content": { "application/json": { "example": { "occupation_code": "2512", "country": "US", "seniority": "senior", "window_days": 90 } } } }, "responses": { "200": { "content": { "application/json": { "example": { "occupation_code": "2512", "occupation_label": "Software Developers", "window_days": 90, "country": "US", "count": 1843, "currency": "USD", "percentiles": { "p10": 118000, "p25": 140000, "p50": 165000, "p75": 192000, "p90": 225000 }, "confidence": "high", "suppressed": false } } } } } } }, { "target": "$.paths['/v1/sandbox/jobs/search'].post", "description": "sandboxSearchJobs", "update": { "tags": [ "Sandbox" ], "requestBody": { "content": { "application/json": { "example": { "job_title_or": [ "backend engineer" ], "limit": 2 } } } }, "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "total_results": 2, "truncated_results": 2, "next_cursor": null }, "data": [ { "id": "sample_job_1", "job_title": "Senior Backend Engineer (Sample)", "company": "Acme Inc", "company_domain": "example.com", "location": "Remote - United States", "country_code": "US", "remote": true, "seniority": "senior", "min_annual_salary_usd": 150000, "max_annual_salary_usd": 190000, "date_posted": "2026-06-01", "technology_slugs": [ "python", "postgresql", "aws" ], "url": "https://example.com/jobs/sample-backend-engineer" } ] } } } } } } }, { "target": "$.paths['/v1/sandbox/jobs/search/batch'].post", "description": "sandboxSearchJobsBatch", "update": { "tags": [ "Sandbox" ], "requestBody": { "content": { "application/json": { "example": { "requests": [ { "job_title_or": [ "backend engineer" ], "limit": 1 }, { "job_country_code_or": [ "DE" ], "limit": 1 } ] } } } }, "responses": { "200": { "content": { "application/json": { "example": { "responses": [ { "status": 200, "body": { "metadata": { "total_results": 1, "truncated_results": 1, "next_cursor": null }, "data": [] } }, { "status": 200, "body": { "metadata": { "total_results": 1, "truncated_results": 1, "next_cursor": null }, "data": [] } } ] } } } } } } }, { "target": "$.paths['/v1/sandbox/jobs/export'].post", "description": "sandboxCreateExport", "update": { "tags": [ "Sandbox" ], "requestBody": { "content": { "application/json": { "example": { "job_title_or": [ "backend engineer" ] } } } }, "responses": { "202": { "content": { "application/json": { "example": { "job_id": "sample_export_1", "status": "completed", "status_url": "https://api.jobspipe.dev/v1/sandbox/jobs/export/sample_export_1" } } } } } } }, { "target": "$.paths['/v1/sandbox/jobs/export/{id}'].get", "description": "sandboxGetExport", "update": { "tags": [ "Sandbox" ], "responses": { "200": { "content": { "application/json": { "example": { "job_id": "sample_export_1", "status": "completed", "result_url": "https://jobspipe.dev/sandbox/sample-export.jsonl" } } } } } } }, { "target": "$.paths['/v1/jobs/companies'].post", "description": "searchHiringCompanies", "update": { "responses": { "200": { "content": { "application/json": { "example": { "metadata": { "total_companies": 1, "returned_companies": 1, "next_cursor": null, "credits_charged": 1, "companies_already_paid": 0 }, "data": [ { "key": "9002", "name": "Google", "legal_name": "GOOGLE LLC", "domain": "google.com", "employee_count": 190000, "industry": "Software", "hq_country": "US", "hq_city": "Mountain View", "employer_type": "employer", "jobs": 305, "jobs_in_subtree": 305, "last_posted": "2026-10-07 06:40:00", "depth": 0, "has_children": false, "children": [] } ] } } } } } } }, { "target": "$.paths['/v1/jobs/companies/{key}'].get", "description": "getCompanyProfile", "update": { "responses": { "200": { "content": { "application/json": { "example": { "key": "9999", "found": true, "header": { "key": "9999", "kind": "company", "name": "Northwind Labs", "description": "A small robotics startup.", "employee_count": 60, "industry": "Robotics", "hq_country": "US", "hq_city": "Mountain View", "open_jobs": 14, "total_jobs": 6048, "countries": 2, "last_posted": "2026-10-07 06:40:00", "parent_of": 0 }, "metadata": { "sections": [ "header" ], "generated_at": "2026-10-07T12:00:00.000Z" } } } } } } } }, { "target": "$.paths['/v1/jobs/companies/{key}/summary'].post", "description": "summarizeCompanyProfile", "update": { "responses": { "200": { "content": { "application/json": { "example": { "key": "9999", "date": "2026-10-07", "source": "template", "bullets": [ { "audience": "sales", "text": "1 new leadership role in the last 30 days (Head of Engineering)." } ], "facts": { "company": "Northwind Labs", "window_weeks": 4 } } } } } } } }, { "target": "$.paths['/v1/layoffs'].get", "description": "searchLayoffs", "update": { "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": "8813620347113906411", "state": "CA", "employer": "Northwind Labs, Inc.", "address": "500 Howard St", "city": "San Francisco", "county": "San Francisco", "zip": "94105", "notice_date": "2026-10-14", "effective_date": "2026-12-13", "employees": 142, "kind": "layoff", "company": { "key": "3837186692681720328", "name": "Northwind Labs", "domain": "northwindlabs.com" } } ], "metadata": { "total_results": 1, "returned_results": 1, "next_offset": null, "credits_charged": 1, "notices_already_paid": 0 } } } } } } } }, { "target": "$.paths['/v1/live/sources'].get", "description": "listLiveSources", "update": { "responses": { "200": { "content": { "application/json": { "example": { "sources": [ { "source": "ashby", "kind": "board", "label": "Ashby", "examples": [ "broccoli", "https://jobs.ashbyhq.com/broccoli" ] } ] } } } } } } }, { "target": "$.paths['/v1/live/{source}'].post", "description": "fetchLive", "update": { "requestBody": { "content": { "application/json": { "example": { "board": "broccoli", "max_jobs": 1 } } } }, "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "id": "6caa6709-30c2-436c-85a1-4d16f711393f", "job_title": "Director of Finance", "company": "broccoli", "company_domain": "broccoli.ai", "url": "https://jobs.ashbyhq.com/broccoli/6caa6709-30c2-436c-85a1-4d16f711393f", "source_url": "https://jobs.ashbyhq.com/broccoli/6caa6709-30c2-436c-85a1-4d16f711393f", "final_url": null, "date_posted": "2026-07-27T17:27:31.444+00:00", "discovered_at": null, "status": "active", "closed_at": null, "closed_reason": null, "location": "San Francisco", "country": "United States", "country_code": "US", "country_codes": [ "US" ], "cities": [ "San Francisco" ], "state_code": "California", "remote": false, "seniority": "director", "employment_statuses": [ "full_time" ], "technology_slugs": [ "excel", "sql" ], "keyword_slugs": [ "accounting", "financial-modeling", "excel", "sql" ], "occupation_code": "1211", "occupation_label": "Finance Managers", "employer_type": "employer", "has_blurred_data": false, "sources": [ { "provider": "ashby", "url": "https://jobs.ashbyhq.com/broccoli/6caa6709-30c2-436c-85a1-4d16f711393f", "seen_at": "2026-08-03T18:16:04.619757+00:00" } ] } ], "metadata": { "source": "ashby", "board": "broccoli", "returned": 1, "next_cursor": null }, "errors": [] } } } } } } } ] }