---
title: "Search Projects"
method: POST
path: "/attendance/projects/search"
tags: ["Projects"]
---

# Search Projects

`POST /attendance/projects/search`

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>

## Request body

- ProjectSearchRequest — Request schema for searching projects.
  - `fields` string[] — 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.
  - `filters` object[] — List of filters to apply
    - `fieldId` '/project/billable' | '/project/clientReference' | '/project/id' | '/project/name' | '/project/status', required — Field ID to filter by. Only the following out-of-the-box fields can be used for filtering: `/project/billable`, `/project/clientReference`, `/project/id`, `/project/name`, `/project/status`
    - `operator` 'equals' | 'notEqual', required — The operator can be `equals` or `notEqual` (for boolean you can only use `equals`)
    - `values` string[], required — One or more values to filter by, provided as strings. For boolean fields, use `true` or `false`.
  - `limit` integer — Specifies the number of entries to include on each page of the results. Defaults to 50 if not supplied. Currently ignored for this endpoint.
  - `cursor` string — 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>.
  - `includeHumanReadable` boolean — Whether to include human-readable values in the response

## Response `200`

A list of Projects matching the search criteria

- ProjectSearchResponse
  - `items` ProjectSearchResponseObject[] — Array of project objects matching the search criteria
    - `objectType` 'project' — Type of the object
    - `fields` object — Project fields returned in search response
      - `/project/id` object
        - `value` integer
        - `humanReadable` string
      - `/project/name` object — The unique project name
        - `value` string
        - `humanReadable` string
      - `/project/description` object
        - `value` string
        - `humanReadable` string
      - `/project/billable` object — Relevant only when tracking by project. Determines whether the attendance entry is billable or not.
        - `value` boolean
        - `humanReadable` string
      - `/project/status` object
        - `value` 'active' | 'archived'
        - `humanReadable` string
      - `/project/clientReference` object — This is a reference to a `projectClient` object. Use the <a href="/reference/post_attendance-project-clients-search" target="_blank">project client search endpoint</a> to get the client details and filter by the ID from `referenceId`.
        - `value` integer
        - `humanReadable` string
      - `/project/audienceSelector` object — Employees assigned to this project. Only assigned employees can log attendance entries for the project. When `mode=all` this means all employees are linked to this project, and `mode=explicit` specifies employees in `employeeIds`. See <a href="/reference/post_people-search" target="_blank">Search for employees</a> to get the employee details by ID.
        - `value` object
          - `mode` 'all' | 'explicit'
          - `employeeIds` string[]
        - `humanReadable` string
      - `/project/taskIds` object — Relevant only when tracking billing by task. The attendance entries are tracked at the task level, and the billable flag of the task determines whether the attendance entry is billable or not. Employees assigned to the project must select a task when logging attendance entries. Use the <a href="/reference/post_attendance-project-tasks-search" target="_blank">project task search endpoint</a> to get the task details.
        - `value` integer[]
        - `humanReadable` string
  - `response_metadata` object
    - `next_cursor` string, nullable — 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>.

## Other responses

- `400` — The request is malformed or includes invalid parameters
- `401` — Authentication failed. Check your service user credentials
- `403` — The service user or token is missing the required permissions to access the requested data
- `429` — Rate limit exceeded - see <a href="https://apidocs.hibob.com/reference/projects#rate-limiting">Rate limits</a>
- `500` — An unexpected error occurred. Try again or contact support if the issue persists.

---

[API](https://skmtc.net/hibob/apis/employee-data-api.md) · [All operations](https://skmtc.net/hibob/apis/employee-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hibob/employee-data-api/versions/0781ebbdda91/schema)