Sign in
latestOpenAPI 3.0.22026-08-1451965.7 KB

f5a72ed18934

Sitemap Employers

Return employer IDs for sitemap generation with pagination. Not metered.

Requires the dedicated sitemap:read scope — intentionally NOT in the free-tier default scopes. The only legitimate caller is the Next.js server generating sitemap shards for SEO; that route uses DEMO_API_KEY whose scopes must include 'sitemap:read'. Free customer keys cannot enumerate the entire dataset via this endpoint.

Pagination: use offset/limit to page through all employers. Returns total_count so the caller knows how many pages to request — the count reflects the indexable_only filter when set.

get/v1/sitemap/employers

Query parameters

limitinteger
offsetinteger
indexable_onlyboolean

When true, return only employers with at least one enforcement signal across any aggregated source. Used by the Next.js sitemap generator so Google isn't asked to crawl thin templated profiles that the page itself noindex's anyway.

When true, return only employers with at least one enforcement signal across any aggregated source. Used by the Next.js sitemap generator so Google isn't asked to crawl thin templated profiles that the page itself noindex's anyway.

Headers

X-Api-Keystring

Response

Successful Response

{"stackTrail":"paths:/v1/sitemap/employers:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}