---
updatedAt: 2025-07-22T07:41:05.000Z
---

Fetch the complete documentation index at: https://apidocs.hibob.com/llms.txt. Use this file to discover all available pages before exploring further.

# Get job family metadata

Returns a list of all fields of object type job family.<br/> <br /><br /> **<b>Required permissions</b>** <br /> The service user making the call must have the required permissions: see <a href="/reference/job-catalog#permissions-required">Permissions required</a>. <br />

# OpenAPI definition

```json
{
  "openapi": "3.1.1",
  "info": {
    "title": "Job Catalog API",
    "description": "Use Public API to access Job Catalog in Bob",
    "license": {
      "name": "Proprietary",
      "url": "https://apidocs.hibob.com/docs/api-terms-of-use"
    },
    "contact": {
      "name": "Hi Bob, Inc."
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.hibob.com/v1",
      "description": "Production"
    },
    {
      "url": "https://api.sandbox.hibob.com/v1",
      "description": "Sandbox"
    }
  ],
  "x-readme": {
    "metrics-enabled": false
  },
  "paths": {
    "/job-catalog/job-families/metadata": {
      "get": {
        "operationId": "get_job-catalog-job-families-metadata",
        "tags": [
          "Job catalog"
        ],
        "summary": "Get job family metadata",
        "description": "Returns a list of all fields of object type job family.<br/> <br /><br /> **<b>Required permissions</b>** <br /> The service user making the call must have the required permissions: see <a href=\"/reference/job-catalog#permissions-required\" target=\"_blank\">Permissions required</a>. <br />",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ObjectsMetadata"
                }
              }
            }
          },
          "400": {
            "description": "Bad request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "429": {
            "description": "Rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        },
        "security": [
          {
            "Basic": []
          },
          {
            "Bearer": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ObjectsMetadata": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the field."
          },
          "name": {
            "type": "string",
            "description": "Name of the field."
          },
          "description": {
            "type": "string",
            "description": "Description of the field."
          },
          "fieldType": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "description": "The type of the field."
              },
              "typeData": {
                "type": "object",
                "properties": {
                  "listId": {
                    "type": "string",
                    "description": "The ID of the list in the /v1/company/named-lists endpoint."
                  }
                }
              }
            }
          },
          "jsonPath": {
            "type": "object",
            "properties": {
              "root": {
                "type": "string",
                "description": "The path to the field json object. The field value and other properties, such as humanReadable value, will be placed inside."
              },
              "rawData": {
                "type": "string",
                "description": "The path to the actual field value."
              }
            }
          }
        }
      },
      "Error": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string",
            "description": "The unique identifier of the error."
          },
          "error": {
            "type": "string",
            "description": "A human readable error message."
          }
        }
      }
    },
    "securitySchemes": {
      "Basic": {
        "type": "http",
        "scheme": "basic"
      },
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "OAuth 2.0",
        "description": "OAuth 2.0 authentication using an Access Token is available for registered partners only.  Try It! does not support the full HiBob OAuth flow. You can follow <a href=\"https://apidocs.hibob.com/reference/oauth-20#testing-from-the-public-api-reference\" target=\"_blank\">these steps</a> to complete the OAuth 2.0 flow in Postman and then paste the token here."
      }
    }
  }
}
```