customization

Stock Schema Fragments List

GET
Lists stock schema fragments.

Query parameters

cursorstringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
filter_presetenumOptional
Filter preset to specify whether to filter only customization enabled leaf types.
Allowed values: customizable_types_presetno_preset
leaf_typestringOptional
The list of leaf types.
limitintegerOptional
The maximum number of items.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values: afterbefore
pruneenumOptional
List of fields which are not required in the payload and can be pruned away.
Allowed values: composite_schemasfields
sort_bystringOptional
The list of fields to sort the items by and how to sort them.

Response

This endpoint returns an object
result
list of objects
The stock 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.
GET
1curl https://api.devrev.ai/schemas.stock.list \
2     -H "Authorization: <apiKey>"
200
Retrieved
1{
2  "result": [
3    {
4      "fields": [],
5      "id": "id",
6      "created_date": "2023-01-01T12:00:00Z",
7      "description": "description",
8      "display_id": "display_id",
9      "leaf_type": "leaf_type",
10      "modified_date": "2023-01-01T12:00:00Z",
11      "title": "title"
12    }
13  ],
14  "next_cursor": "next_cursor",
15  "prev_cursor": "prev_cursor"
16}
Built with