Search Projects

Retrieve project data based on specified filters. This endpoint requires body parameters, which is why it uses 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 the 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.
Body Params

Search criteria for filtering projects.

fields
array of strings
required

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

fields*
filters
array of objects | null

List of filters to apply

filters
integer | null

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 | null

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 | null

Whether to include human-readable values in the response

Responses

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