customization

Custom Schema Fragments List Post

POST
Lists custom schema fragments.

Request

This endpoint expects an object.
app
list of stringsOptional
The list of app names.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
deprecated
booleanOptional
Whether only deprecated fragments should be filtered.
leaf_type
list of stringsOptional
The list of leaf types.
limit
integerOptional
The maximum number of items.
mode
enumOptional
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: afterbefore
prune
list of "fields"Optional
List of fields which are not required in the payload and can be pruned away.
sort_by
list of stringsOptional
The list of fields to sort the items by and how to sort them.
subtype
list of stringsOptional
The list of subtypes.
types
list of enumsOptional
Filters for custom schema fragment of the provided types.
Allowed values: app_fragmentcustom_type_fragmenttenant_fragment

Response

This endpoint returns an object
result
list of unions
The custom schema fragments.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
POST
1curl -X POST https://api.devrev.ai/schemas.custom.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
1{
2  "result": [],
3  "next_cursor": "next_cursor",
4  "prev_cursor": "prev_cursor"
5}
Built with