Salaries namespace

Reference for salary data by title, skill, and location.

Programmatic salary directory and detail data. Use the formatting and SEO helper packages for presentation.

Salary pages are public. Pass { locale: context.language } to overlay board-language names and canonical slugs; omitting it uses the English identity path.

Company salary index

1board.salaries.companies.list(
2  options?: FetchOptions,
3): Promise<ListEnvelope<SalaryCompany>>

Returns companies ranked for the /salaries/companies hub.

1const { data: companies } = await board.salaries.companies.list();

Company-specific salary detail methods live under board.companies.salaries because they share the public company namespace.

Title methods

1board.salaries.titles.list(
2  query?: { locale?: string },
3  options?: FetchOptions,
4): Promise<ListEnvelope<SalaryTitle>>
5
6board.salaries.titles.retrieve(
7  titleSlug: string,
8  query?: { locale?: string },
9  options?: FetchOptions,
10): Promise<TitleSalaryDetail>
11
12board.salaries.titles.locations(
13  titleSlug: string,
14  query?: { locale?: string },
15  options?: FetchOptions,
16): Promise<TitleLocationsIndex>
17
18board.salaries.titles.location(
19  titleSlug: string,
20  locationSlug: string,
21  query?: { locale?: string },
22  options?: FetchOptions,
23): Promise<TitleLocationSalary>

1const { language } = await board.context();
2const { data: titles } = await board.salaries.titles.list({
3  locale: language,
4});
5
6const detail = await board.salaries.titles.retrieve(
7  titles[0].slug,
8  { locale: language },
9);

Skill methods

1board.salaries.skills.list(
2  query?: { locale?: string },
3  options?: FetchOptions,
4): Promise<ListEnvelope<SalarySkill>>
5
6board.salaries.skills.retrieve(
7  skillSlug: string,
8  query?: { locale?: string },
9  options?: FetchOptions,
10): Promise<SkillSalaryDetail>
11
12board.salaries.skills.locations(
13  skillSlug: string,
14  query?: { locale?: string },
15  options?: FetchOptions,
16): Promise<SkillLocationsIndex>
17
18board.salaries.skills.location(
19  skillSlug: string,
20  locationSlug: string,
21  query?: { locale?: string },
22  options?: FetchOptions,
23): Promise<SkillLocationSalary>

Location methods

1board.salaries.locations.list(
2  query?: { locale?: string },
3  options?: FetchOptions,
4): Promise<ListEnvelope<SalaryLocation>>
5
6board.salaries.locations.retrieve(
7  locationSlug: string,
8  query?: { locale?: string },
9  options?: FetchOptions,
10): Promise<LocationSalaryDetail>
11
12board.salaries.locations.titles(
13  locationSlug: string,
14  query?: { locale?: string },
15  options?: FetchOptions,
16): Promise<LocationTitlesIndex>
17
18board.salaries.locations.skills(
19  locationSlug: string,
20  query?: { locale?: string },
21  options?: FetchOptions,
22): Promise<LocationSkillsIndex>

SalaryLocation rows form a flattened hierarchy through parentSlug; rebuild country, region, and city navigation from those edges.

Canonical slug handling

Detail responses carry source and canonical slug fields. The API returns data rather than performing a redirect. When the inbound slug differs from the response’s canonical slug, issue a permanent redirect from the frontend route.

1const detail = await board.salaries.skills.retrieve(inboundSlug, {
2  locale: context.language,
3});
4
5if (detail.canonicalSlug !== inboundSlug) {
6  return Response.redirect(
7    new URL(`/salaries/skills/${detail.canonicalSlug}`, origin),
8    308,
9  );
10}

Cross-axis detail responses include canonical source/entity/place slugs appropriate to both axes. Build paths with @cavuno/board/paths instead of concatenating translated names.

Presentation and errors

Use the salary builders in @cavuno/board/seo for Occupation, distribution, list, and FAQ structured data. Use @cavuno/board/format for board-language money ranges. Per-seniority distribution names are application-owned — pass seniorityName({ seniority, entity }) that returns the finished string in board-language order (do not rely on the SDK to join seniority + title).

Missing data throws the axis-specific 404 code: salaries_title_not_found, salaries_skill_not_found, salaries_location_not_found, salaries_title_location_not_found, or salaries_skill_location_not_found. Render a true 404 or a related salary index—do not turn missing salary evidence into zero pay.