UserDefinedFunctionService

ListUserDefinedFunctions

Retrieve the latest versions of user defined functions based on an optional filter.

get/api/v1/user-defined-functions

Request

  • Base URL: https://api.siftstack.com
  • URL: https://api.siftstack.com/api/v1/user-defined-functions
  • Auth: HTTP bearer

Query parameters

pageSizeinteger

The maximum number of user defined functions to return. The service may return fewer than this value. If unspecified, at most 50 user defined functions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.

pageTokenstring

A page token, received from a previous ListUserDefinedFunctions call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListUserDefinedFunctions must match the call that provided the page token. Optional.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are user_defined_function_id, name, archived_date, and is_archived. For further information about how to use CELs, please refer to this guide.

orderBystring

How to order the retrieved user defined functions. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are created_date, modified_date, and name. If left empty, items are ordered by created_date in descending order (newest-first). For more information about the format of this field, read this Example: "created_date desc,modified_date".

Response

A successful response.

nextPageTokenstring

Changes

No recorded changes to this operation across all 1 revision of this API.