API Reference
Become a partner

Search Key Results

post
https://api.hibob.com/v1/goals/goals/key-results/search

Search for Key Results of a specific Goals, using filters. The goalId filter is mandatory.
Note: 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.

Body Params
fields
array of strings
required

List of fields IDs to include in the response. Use the metadata endpoints to fetch the available fields.

fields*
filters
array of objects
required

List of filters to apply to the search. Multiple filters use AND logic.

Key Result Filters:

goalId - Required for Key Results
Mandatory filter to specify which goal's key results to retrieve.
- Values: Goal ID as string
- Example: ["123"]

filters*
integer

Maximum number of results to return (Note: pagination parameters are currently accepted but not enforced).

string

Cursor for pagination (Note: pagination parameters are currently accepted but not enforced).

Responses

Updated 7 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago