FirstSpirit REST API icon

FirstSpirit REST API

Interact with FirstSpirit REST API

Search → Search Project

AI-generated

Summary

Searches for items within a specified FirstSpirit project using a query string, supporting pagination through page number and size parameters.

Inputs

  • Project ID (required) — The ID of the project to search within.
  • Search Query (required) — The query string defining the search criteria.
  • Page Number — The page number of results to retrieve, defaults to 0.
  • Page Size — The number of items per page in the search results, defaults to 20.

Output shape

a JSON object representing the search results for the specified project, including items matching the query and pagination metadata if provided.

The operation performs an authenticated GET request returning JSON-formatted search results. Pagination parameters control the subset of results returned.

Examples

Example 1: Retrieve first page of 20 results for query 'example' in project '123'

Set Project ID to '123', Search Query to 'example', Page Number to 0, and Page Size to 20.

Discussion