---
updatedAt: 2025-12-21T09:38:41.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 Goal Cycle Metadata

Returns the goal cycle fields metadata schema.


# OpenAPI definition

```json
{
  "openapi": "3.1.1",
  "info": {
    "title": "Goals API",
    "description": "Public API for managing Goal Types, Goals, and Key Results with clean entity separation.",
    "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
  },
  "tags": [
    {
      "name": "Goals",
      "description": "Operations for managing Goal Types, Goals, and Key Results"
    }
  ],
  "paths": {
    "/goals/goal-cycles/metadata": {
      "get": {
        "operationId": "get_goals-goal-cycles-metadata",
        "tags": [
          "Goals"
        ],
        "summary": "Get Goal Cycle Metadata",
        "description": "Returns the goal cycle fields metadata schema.\n",
        "responses": {
          "200": {
            "description": "Fields of a cycle object.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/MetadataObject"
                      }
                    }
                  }
                },
                "example": {
                  "items": [
                    {
                      "id": "goalCycle",
                      "displayName": "The Goal Cycle Object",
                      "fields": [
                        {
                          "id": "id",
                          "type": {
                            "dataType": "number"
                          },
                          "propertiesValues": {
                            "isRequired": {
                              "value": false
                            },
                            "displayName": {
                              "value": "ID"
                            },
                            "description": {
                              "value": "The unique identifier for the cycle"
                            }
                          }
                        },
                        {
                          "id": "name",
                          "type": {
                            "dataType": "string"
                          },
                          "propertiesValues": {
                            "isRequired": {
                              "value": false
                            },
                            "displayName": {
                              "value": "Name"
                            },
                            "description": {
                              "value": "The display name of the cycle"
                            }
                          }
                        },
                        {
                          "id": "startDate",
                          "type": {
                            "dataType": "date"
                          },
                          "propertiesValues": {
                            "isRequired": {
                              "value": false
                            },
                            "displayName": {
                              "value": "Start Date"
                            },
                            "description": {
                              "value": "The start date of the cycle"
                            }
                          }
                        },
                        {
                          "id": "endDate",
                          "type": {
                            "dataType": "date"
                          },
                          "propertiesValues": {
                            "isRequired": {
                              "value": false
                            },
                            "displayName": {
                              "value": "End Date"
                            },
                            "description": {
                              "value": "The end date of the cycle"
                            }
                          }
                        }
                      ]
                    }
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "429": {
            "description": "Rate limit exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "Basic": []
          },
          {
            "Bearer": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ApiErrorResponse": {
        "type": "object",
        "required": [
          "error",
          "message",
          "statusCode",
          "timestamp"
        ],
        "properties": {
          "error": {
            "type": "string",
            "description": "Error type identifier",
            "enum": [
              "BAD_REQUEST",
              "NOT_FOUND",
              "INTERNAL_SERVER_ERROR",
              "TOO_MANY_REQUESTS",
              "UNAUTHORIZED",
              "FORBIDDEN"
            ],
            "example": "BAD_REQUEST"
          },
          "message": {
            "type": "string",
            "description": "Human-readable error message",
            "example": "Invalid input provided"
          },
          "statusCode": {
            "type": "integer",
            "description": "HTTP status code",
            "enum": [
              400,
              401,
              403,
              404,
              429,
              500
            ],
            "example": 400
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "ISO timestamp when the error occurred",
            "example": "2025-01-01T12:00:00Z"
          }
        }
      },
      "FieldType": {
        "type": "object",
        "properties": {
          "dataType": {
            "type": "string",
            "description": "The data type of the field",
            "enum": [
              "string",
              "number",
              "boolean",
              "date"
            ]
          }
        }
      },
      "PropertyValue": {
        "type": "object",
        "properties": {
          "value": {
            "description": "The property value (can be string, boolean, number, etc.)",
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "boolean"
              },
              {
                "type": "number"
              },
              {
                "type": "integer"
              }
            ]
          }
        }
      },
      "PropertiesValues": {
        "type": "object",
        "description": "Field properties including isRequired, displayName, and description",
        "properties": {
          "isRequired": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PropertyValue"
              },
              {
                "description": "Whether the field is required (boolean value)"
              }
            ]
          },
          "displayName": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PropertyValue"
              },
              {
                "description": "Human-readable display name (string value)"
              }
            ]
          },
          "description": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PropertyValue"
              },
              {
                "description": "Field description (string value)"
              }
            ]
          }
        }
      },
      "FieldMetadata": {
        "type": "object",
        "description": "Metadata for a field including its type and properties",
        "properties": {
          "id": {
            "type": "string",
            "description": "The field path identifier (e.g., /goal/id, /goalType/name)"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/FieldType"
              },
              {
                "description": "The field type information"
              }
            ]
          },
          "propertiesValues": {
            "allOf": [
              {
                "$ref": "#/components/schemas/PropertiesValues"
              },
              {
                "description": "Field properties including isRequired, displayName, and description"
              }
            ]
          }
        }
      },
      "MetadataObject": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The object identifier",
            "enum": [
              "goal",
              "goalType",
              "goalCycle",
              "keyResult"
            ]
          },
          "displayName": {
            "type": "string",
            "description": "Human-readable object name",
            "enum": [
              "The Goal Object",
              "The Goal Type Object",
              "The Goal Cycle Object",
              "The Key Result Object"
            ]
          },
          "fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/FieldMetadata"
            },
            "description": "Array of field metadata for this object type"
          }
        }
      }
    },
    "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."
      }
    }
  }
}
```