---
updatedAt: 2025-12-21T10:29:01.000Z
---
Fetch the complete documentation index at: https://apidocs.hibob.com/llms.txt. Use this file to discover all available pages before exploring further.
# Search Goal Cycles
Search for available goal cycles. Returns all goal cycles accessible to the authenticated user.
**Notes**:
- Filters are not supported for this
endpoint. Providing filters will result in a 400 error.
- Pagination parameters are currently accepted but not enforced.
**Testing notes:**
- Use the testing widget's **Try It!** option to test this endpoint.
- Use the **Examples > Request Example** option to see how to initiate body parameters.
# 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/search": {
"post": {
"operationId": "post_goals-goal-cycles-search",
"tags": [
"Goals"
],
"summary": "Search Goal Cycles",
"description": "Search for available goal cycles. Returns all goal cycles accessible to the authenticated user.
**Notes**: \n - Filters are not supported for this\nendpoint. Providing filters will result in a 400 error. \n - Pagination parameters are currently accepted but not enforced.\n\n \n**Testing notes:**
- Use the testing widget's **Try It!** option to test this endpoint.
- Use the **Examples > Request Example** option to see how to initiate body parameters.
\n",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CycleSearchRequest"
},
"example": {
"fields": [
"id",
"name",
"startDate",
"endDate"
],
"filters": [],
"limit": 50
}
}
}
},
"responses": {
"200": {
"description": "Goal cycle object fields.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SearchResponseCycles"
},
"example": {
"items": [
{
"objectType": "goalCycle",
"fields": {
"id": {
"value": 456
},
"name": {
"value": "Q1 2025"
},
"startDate": {
"value": "2025-01-01"
},
"endDate": {
"value": "2025-03-31"
}
}
},
{
"objectType": "goalCycle",
"fields": {
"id": {
"value": 789
},
"name": {
"value": "Q2 2025"
},
"startDate": {
"value": "2025-04-01"
},
"endDate": {
"value": "2025-06-30"
}
}
}
],
"responseMetadata": {
"totalCount": 2,
"pageSize": 50
},
"nextCursor": null,
"errors": null
}
}
}
},
"400": {
"description": "Bad request with structured error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
},
"example": {
"error": "BAD_REQUEST",
"message": "Filters are not supported for this endpoint",
"statusCode": 400,
"timestamp": "2025-01-01T12:00:00Z"
}
}
}
},
"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"
}
}
},
"SearchResponseMetadata": {
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"format": "int64",
"description": "Total number of items available"
},
"pageSize": {
"type": "integer",
"description": "Number of items requested per page"
}
}
},
"CycleSearchRequest": {
"type": "object",
"description": "Request schema for searching goal cycles",
"required": [
"fields"
],
"properties": {
"fields": {
"type": "array",
"description": "List of fields IDs to include in the response. Use the metadata endpoints to fetch the available fields.\n",
"items": {
"type": "string"
}
},
"filters": {
"type": "array",
"description": "Filters array (currently not supported - must be empty or omitted)",
"items": {
"type": "object"
}
},
"limit": {
"type": "integer",
"description": "Number of items per page"
},
"cursor": {
"type": "string",
"description": "Pagination cursor for next page"
}
}
},
"SearchResponseCycles": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CycleObject"
},
"description": "Array of Goal Cycle items"
},
"responseMetadata": {
"allOf": [
{
"$ref": "#/components/schemas/SearchResponseMetadata"
},
{
"description": "Metadata about the search response"
}
]
},
"nextCursor": {
"type": [
"string",
"null"
],
"description": "Cursor for next page (null if no more pages)"
},
"errors": {
"type": [
"object",
"null"
],
"description": "Error information if any"
}
}
},
"CycleObject": {
"type": "object",
"properties": {
"objectType": {
"type": "string",
"description": "The type of the object",
"enum": [
"goalCycle"
]
},
"fields": {
"type": "object",
"description": "Goal cycle fields",
"properties": {
"id": {
"type": "object",
"description": "The unique identifier for the cycle",
"properties": {
"value": {
"type": "integer",
"format": "int64"
}
}
},
"name": {
"type": "object",
"description": "The display name of the cycle",
"properties": {
"value": {
"type": "string"
}
}
},
"startDate": {
"type": "object",
"description": "The start date of the cycle",
"properties": {
"value": {
"type": "string",
"format": "date"
}
}
},
"endDate": {
"type": "object",
"description": "The end date of the cycle",
"properties": {
"value": {
"type": "string",
"format": "date"
}
}
}
}
}
}
}
},
"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 these steps to complete the OAuth 2.0 flow in Postman and then paste the token here."
}
}
}
}
```