v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Projects

Search Projects

This endpoint allows you to retrieve project data based on specified filters. Please note that this endpoint requires body parameters, which is why it utilizes a POST request for a read operation. <p><b>Before using this endpoint:</b></p> <ul> <li>Explore the <a href="/docs/explore-attendance-api" target="_blank">Attendance API</a> for more details on usage, rate limits, permissions, and more.</li> <li>Only project fields mentioned in the fields parameter are returned. Use <a href="/reference/get_attendance-projects-metadata" target="_blank">project metadata endpoint</a> to get the field IDs.</li> <li><b>Pagination note:</b> Pagination parameters are currently accepted but not enforced. The response includes all matching results regardless of the limit or cursor values. Pagination will be implemented in a future version to limit results per page. To learn more, see <a href="https://apidocs.hibob.com/docs/pagination" target="_blank"> Pagination in Bob’s API</a>.</li> </ul> <p><b>Testing notes</b>:</p>

<ul> <li>Use the testing widget's <b>Try It!</b> option to test this endpoint.</li> <li>Use the <b>Examples > Request Example</b> option to see how to initiate body parameters.</li> </ul>
post/attendance/projects/search

Request body

fieldsstring[]

List of field paths to include in the response. Standard fields are listed above. Custom fields following the pattern /project/field_<number> are also supported.

limitinteger

Specifies the number of entries to include on each page of the results. Defaults to 50 if not supplied. Currently ignored for this endpoint.

cursorstring

A marker representing the first item on the next page to read. Do not provide it in the first call. Currently ignored for this endpoint. To learn more, see <a href="https://apidocs.hibob.com/reference/pagination-1" target="_blank"> Pagination in Bob's API</a>.

includeHumanReadableboolean

Whether to include human-readable values in the response

Example request

{
  "fields": [
    "/project/id",
    "/project/name",
    "/project/status"
  ],
  "filters": [
    {
      "fieldId": "/project/status",
      "operator": "equals",
      "values": [
        "active"
      ]
    }
  ]
}

Response

A list of Projects matching the search criteria