API ReferenceCustomization

List Schemas Custom (POST)

Lists custom schema fragments.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
applist of stringsOptional
The list of app names.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
is_custom_leaf_typebooleanOptional
Whether the leaf type corresponds to a custom object
is_deprecatedbooleanOptional
Whether the fragment has been deprecated.
leaf_typelist of stringsOptional
The list of leaf types.
limitintegerOptional
The maximum number of items.
modeenumOptional

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.

Allowed values:
prunelist of enumsOptional
List of fields which are not required in the payload and can be pruned away.
Allowed values:
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
Filters for custom schema fragment of the provided types.
Allowed values:
deprecatedbooleanOptionalDeprecated
Whether only deprecated fragments should be filtered.

Response

Success.
resultlist of objects
The custom schema fragments.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors