GET /api/v2/it_asset_management/assets/search

Returns an array of assets with values in text-based fields that match the search query.

If the query includes multiple words or numbers, it's treated as a space-separated list of search terms and assets with values matching one or more of the terms are returned. For example, query=laptop Apple 2024 is encoded as query=laptop%20Apple%202024 and treated as three distinct search terms: laptop, Apple, and 2024. Every asset record with a text field containing 'laptop', 'Apple', or '2024' is returned.

If you need to search by more complex logic, use the Filtered Search API endpoint.

Pagination

Allowed For

Servers

Query parameters

Name Type Required Description
page[after] String No

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

query String Yes

Lists the search terms, separated by a space, used to identify the asset records.

page[before] String No

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

sort String No

Orders the returned records by: name, created_at, or updated_at. Defaults to sorting by relevance. Prepending - (-name, -created_at, or -updated_at) sorts the results in descending order by that value.

page[size] Integer No

Specifies how many assets should be returned in the response, up to 100 assets per page.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.