v66

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-04176310979.2 KB
tools

Tool List

List the existing tools

get/api/v1/tools/

Query parameters

pageinteger nullable

The page number from which to start (0-based)

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25

The maximum number of items to return

search_fieldsToolProperties[]

String names of fields to search. Correspond by index to search field values

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

order_by'id' | 'name' | 'service_name' | 'definition' | 'service_id' | 'last_updated' | 'last_updated_by'

Names of tool fields supported for filtering/sorting on list endpoint.

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsToolProperties[] nullable

The fields to include in the response

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z

The start datetime for filtering results

end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

The end datetime for filtering results

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query