HIhibob
Goals

Search Goal Types

Search for the available Goal Types using filters and pagination parameters. <br>Note: Pagination parameters are currently accepted but not enforced. <br><br> Testing notes: <br> - Use the testing widget's Try It! option to test this endpoint.<br> - Use the Examples > Request Example option to see how to initiate body parameters.<br>

post/goals/goal-types/search

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/goals/goal-types/search
  • Auth
    • HTTP basic
    • or HTTP bearer

Request body

fieldsstring[] required

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

limitinteger

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

cursorstring

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

Response

Goal type object fields.

nextCursorstring nullable

Cursor for next page (null if no more pages)

errorsobject nullable

Error information if any

Changes

No recorded changes to this operation across all 1 revision of this API.