Custom Schema Fragments List Post

POST

Lists custom schema fragments.

Request

This endpoint expects an object.
applist of stringsOptional

The list of app names.

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

deprecatedbooleanOptionalDefaults to false

Whether only deprecated fragments should be filtered.

is_custom_leaf_typebooleanOptionalDefaults to false

Whether the leaf type corresponds to a custom object

leaf_typelist of stringsOptional

The list of leaf types.

limitintegerOptional

The maximum number of items.

mode"after" or "before"Optional
Allowed values: afterbefore

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

prunelist of "fields"Optional

List of fields which are not required in the payload and can be pruned away.

sort_bylist of stringsOptional

The list of fields to sort the items by and how to sort them.

subtypelist of stringsOptional

The list of subtypes.

typeslist of enumsOptional
Allowed values: app_fragmentcustom_type_fragmenttenant_fragment

Filters for custom schema fragment of the provided types.

Response

This endpoint returns an object.
resultlist of objects

The custom schema fragments.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.