API Reference
Become a partner

Search Projects

post
https://api.hibob.com/v1/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.

Before using this endpoint:

  • Explore the Attendance API for more details on usage, rate limits, permissions, and more.
  • Only project fields mentioned in the fields parameter are returned. Use project metadata endpoint to get the field IDs.
  • Pagination note: 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 Pagination in Bob’s API.

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
Defaults to /project/id,/project/name,/project/status

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.

fields
filters
array of objects
Defaults to [object Object]

List of filters to apply

filters
string
enum
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

Allowed:
string
enum
required

The operator can be equals or notEqual (for boolean you can only use equals)

Allowed:
values
array of strings
required

One or more values to filter by, provided as strings. For boolean fields, use true or false.

values*
integer
0 to 1000
Defaults to 50

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

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 Pagination in Bob's API.

boolean
Defaults to true

Whether to include human-readable values in the response

Responses

Updated 4 months ago

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

Updated 4 months ago