Explore Job catalog API

Bob's Job catalog 2.0 is a database that details the hierarchy of all the jobs in your organization. In this article, you will learn how to access the job catalog API to read Job profiles and their components.

📘
Note:
The Job catalog API is available only for users working with the new Job catalog 2.0, currently open only to new customers and customers who had not used the job catalog before February 9, 2025. To learn more, see Getting started with the new job catalog ↗.

Key concepts

The Job catalog's main components are the Job profiles, which are based on roles and levels.

The components are defined in the Job content library, which contains the job roles, levels, and families. The attributes, or fields that comprise each component, are defined in the Job catalog settings in Bob.

Job profile

Job profiles are the core entity of the Job catalog. They combine the job role, track, and level for each specific job in your organization and cover the key skills, experience, and responsibilities required for the job.

In Bob, the Job profile can be linked to specific people and various products within Bob, such as: Workforce planning Positions, Compensation Salary bands, and Competencies.

Using the Public API you can search for Job profiles and fetch their fields.

Job profile fields

Field	Description
id	The backend-id of the job profile
jobLevelRoleId	The Job track + Job level. Use the `includeHumanReadable` flag to fetch the string containing both. For example: "Managerial \ Lead": Track="Managerial" and Level name="Lead".
jobRoleId	The identifier of the role linked to this profile. Use Get all job roles to retrieve the role details.
jobFamilyId	The identifier of the role family linked to this profile. Use Get all job families to retrieve the role family details.
jobFamilyGroupId	The identifier if the role family group linked to this profile. Use Get all job family groups to retrieve the role details.
code	A unique identifier for the job profile, auto-generated in Bob. Can be customized when creating a new profile.
title	The job profile’s name can be automatically generated using: job level + role + family + family group. Alternatively, users can manually set the title.
status	The status of the job profile. Possible values: active, draft, and inactive.
description	A text description for this job profile
assignedEmployees	An array with backend-id of the employees that are linked to this job profile. Use Read company employee fields by employee ID to get the employee details.

Job content library

The Job content library in Bob is where you define your job roles, families, family groups, and levels.

You can retrieve roles, families, and family groups using the Public API:

Job roles: A Job role is the core job description. It is a mandatory part of a job profile, and is always linked to the job level.
Job levels: The job’s Level is also a mandatory part of a job profile. It indicates seniority or expertise within a role. Job levels are broken down by track, grade, and level and built as a matrix table similar to the Mercer career levels structure, where:
- Job Track: Represents different career types or paths within the organization (e.g., "Executive", "Managerial", "Professional").
- Job Level: The level name, e.g. "Director", "Senior manager", "Manager", and "Lead".
- Job Grade: Defines the hierarchy within tracks, indicating increasing seniority or responsibility. Grades define sensitive information, such as salary range, require specific permissions, and are inaccessible via the Public API.

📘
Notes:

The Job level and Job Track cannot be retrieved directly from the Public API. They are returned only as part of the Job profile, in the jobLevelRoleId (e.g. "Managerial \ Lead" where Track=Managerial, and Level=Lead).

The Grade cannot be accessed from the Public API at the moment.

Job family: A job family group focuses on a lower-level classification of the domain within the organization.
Job family group: The family group defines to which primary domain or area of work within the organization this family group belongs.

Job catalog settings

The Job catalog settings in Bob are where you manage the settings and attributes (fields) of all the job catalog components.

Each Job catalog component, such as profile, job family, family group or role, consists of attributes (or fields) that can be out-of-the-box or customized.

Using the Public API you can retrieve the attributes of profiles, roles, families, and family groups.

Job catalog API endpoints

The Job catalog API provides endpoints for retrieving and filtering job catalog data, offering a structured view of your organization's job architecture.

UI Component	Public API Endpoint	Description
Job profiles	Read company job profiles	Search for job profiles. Each profile contains a reference to the relevant job families, groups, and roles. You can filter by status, role and family..
Job catalog settings: Attributes/fields (Metadata)	Get all job role fields Get all job family fields Get all job family group fields Get all job profiles fields	Get the fields metadata for all entities When to use? If you have defined custom fields and you need to retrieve their settings.
Job content library: Job roles, families and groups	Get all job roles Get all job families Get all job family groups	Get all defined roles, job families, and family groups When to use? If you want to filer job profiles by role, family or family group - use these endpoints to retrieve possible values.

To learn more about the endpoints, permissions, error codes and rate limits, see the Job catalog reference guide.

Job profile JSON example

{
            "/jobProfile/code": {
                "humanReadable": "J-Sample-933311247",
                "value": "J-Sample-933311247"
            },
            "/jobProfile/jobFamilyGroupId": {
                "humanReadable": "Engineering & R&D",
                "value": 9771754
            },
            "/jobProfile/jobFamilyId": {
                "humanReadable": "Software Engineering",
                "value": 9771763
            },
            "/jobProfile/status": {
                "humanReadable": "Active",
                "value": "Active"
            },
            "/jobProfile/title": {
                "humanReadable": "Junior Software Engineer Software Engineering Engineering & R&D",
                "value": "Junior Software Engineer Software Engineering Engineering & R&D"
            },
            "/jobProfile/jobLevelRoleId": {
                "humanReadable": "Managerial \\ Lead",
                "value": 9771901
            },
            "/jobProfile/assignedEmployees": {
                "humanReadable": "Mary Jacobs",
                "value": [
                    "33416864481211842262"
                ]
            },
            "/jobProfile/description": {
                "humanReadable": "This role is responsible for all tasks and duties related to Junior Software Engineer within the software engineering family, ensuring smooth and efficient operations.",
                "value": "This role is responsible for all tasks and duties related to Junior Software Engineer within the software engineering family, ensuring smooth and efficient operations."
            },
            "/jobProfile/id": {
                "humanReadable": "9771922",
                "value": 9771922
            },
            "/jobProfile/jobRoleId": {
                "humanReadable": "Software Engineer",
                "value": 9771783
            }
        },

Common use cases

Connecting to Hiring applications
Hiring applications help companies manage job postings, candidate tracking, and recruitment processes. The Job Catalog API allows external systems to fetch job profiles, ensuring hiring decisions align with internal structures. Since each job profile is linked to a job role, external systems can maintain consistency in job definitions across platforms.

By integrating hiring applications with the Job Catalog API, companies can:

Retrieve standardized job profiles to ensure job postings match internal role definitions.
Ensure alignment between hiring tools and internal job structures by linking job profiles to job roles.
Enable future expansion to support additional attributes such as skills and competencies.
Facilitate seamless onboarding by ensuring new hires transition smoothly into workforce planning, learning, and compensation systems.

This integration helps maintain a structured and consistent hiring process while reducing discrepancies between internal job definitions and external recruitment tools.

Financial planning tools

Financial planning tools rely on structured job data to support workforce budgeting and compensation planning. The Job Catalog API enables these tools to fetch job profiles, ensuring financial models reflect the organization's job architecture.

By integrating with financial planning tools, the API allows companies to:

Retrieve job profiles to align budgeting with organizational job structures.
Incorporate job data into financial planning to accurately forecast salary expenses and workforce costs.
Streamline budget allocation by ensuring approved financial plans tie back to job roles.
Support hiring workflows by pushing budgeted positions as job openings in hiring tools.

This integration helps organizations align financial planning with workforce management, improving budgeting accuracy and hiring efficiency.

Enterprise analytics

Organizations using enterprise analytics solutions, such as Tableau over Snowflake, rely on a unified data structure to analyze workforce trends alongside financial and sales performance. The Job Catalog API enables companies to export structured job data, integrating it with ERP and CRM systems in a cloud data warehouse or lake.

By leveraging the Job Catalog API for enterprise analytics, companies can:

Unify job data with financial, sales, and operational data for deeper business insights.
Enhance workforce analytics by combining job structures with performance and revenue data, especially for sales teams.
Enable advanced reporting in enterprise BI tools by structuring job roles, families, and levels for cross-functional analysis.
Improve strategic decision-making with a comprehensive view of workforce impact on business performance.

This integration helps organizations turn workforce data into actionable insights, supporting better planning and operational efficiency.

Career Development

Companies using career development tools to manage employee growth and progression can use the Job Catalog API to retrieve job profiles. This helps organizations structure career pathways and guide employee development.

By integrating career development tools with the Job Catalog API, companies can:

Access job roles to define career progression paths.
Support career planning discussions with structured job data.
Ensure alignment between internal job structures and external career development frameworks.
Enhance employee growth opportunities by mapping career tracks and potential promotions.

This integration helps organizations provide structured career development planning, even when using external tools.

Explore Job catalog API

📘
Note:

Key concepts

Job profile

Job profile fields

Job content library

📘
Notes:

Job catalog settings

Job catalog API endpoints

Job profile JSON example

Common use cases

📘Note:

Key concepts

Job profile

Job profile fields

Job content library

📘Notes:

Job catalog settings

Job catalog API endpoints

Job profile JSON example

Common use cases

📘
Note:

📘
Notes: