Custom Schema Fragments List

GET

Lists custom schema fragments.

Query parameters

appstringOptional

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_typestringOptional

The list of leaf types.

limitintegerOptional

The maximum number of items.

mode"after" or "before"Optional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore
prune"fields"OptionalDefaults to fields

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

sort_bystringOptional

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

subtypestringOptional

The list of subtypes.

typesenumOptional

Filters for custom schema fragment of the provided types.

Allowed values: app_fragmentcustom_type_fragmenttenant_fragment

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.