---
title: "Get Goal Type Metadata"
method: GET
path: "/goals/goal-types/metadata"
tags: ["Goals"]
---

# Get Goal Type Metadata

`GET /goals/goal-types/metadata`

## Request

- Base URL: `https://api.hibob.com/v1`
- URL: `https://api.hibob.com/v1/goals/goal-types/metadata`
- Auth: one of:
  - HTTP basic
  - HTTP bearer

Returns the goal type fields.

## Response `200`

Fields of a goal type.

- object
  - `items` MetadataObject[]
    - `id` 'goal' | 'goalType' | 'goalCycle' | 'keyResult': The object identifier
    - `displayName` 'The Goal Object' | 'The Goal Type Object' | 'The Goal Cycle Object' | 'The Key Result Object': Human-readable object name
    - `fields` FieldMetadata[]: Array of field metadata for this object type
      - `id` string: The field path identifier (e.g., /goal/id, /goalType/name)
      - `type` object: The field type information
        - `dataType` 'string' | 'number' | 'boolean' | 'date': The data type of the field
      - `propertiesValues` object: Field properties including isRequired, displayName, and description
        - `isRequired` object: Whether the field is required (boolean value)
          - `value` union: The property value (can be string, boolean, number, etc.)
            - string
            - boolean
            - number
            - integer
        - `displayName` object: Human-readable display name (string value)
          - `value` union: The property value (can be string, boolean, number, etc.)
            - string
            - boolean
            - number
            - integer
        - `description` object: Field description (string value)
          - `value` union: The property value (can be string, boolean, number, etc.)
            - string
            - boolean
            - number
            - integer

## Other responses

- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/hibob/apis/goals-api.md) - [All operations](https://skmtc.dev/hibob/apis/goals-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hibob/apis/goals-api/revisions/d84d4577bf83?raw)