List Custom Objects (POST) | DevRev

1 curl -X POST https://api.devrev.ai/custom-objects.list \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "leaf_type": "foo" 6 }'

1 { 2 "result": [ 3 { 4 "id": "foo", 5 "created_by": { 6 "display_id": "foo", 7 "id": "foo", 8 "display_name": "foo", 9 "display_picture": { 10 "display_id": "foo", 11 "id": "foo", 12 "file": { 13 "type": "foo", 14 "name": "foo", 15 "size": 42 16 } 17 }, 18 "email": "foo", 19 "full_name": "foo", 20 "state": "active" 21 }, 22 "created_date": "2023-01-01T12:00:00.000Z", 23 "custom_fields": {}, 24 "custom_schema_fragments": [ 25 "foo" 26 ], 27 "display_id": "foo", 28 "leaf_type": "foo", 29 "modified_by": { 30 "display_id": "foo", 31 "id": "foo", 32 "display_name": "foo", 33 "display_picture": { 34 "display_id": "foo", 35 "id": "foo", 36 "file": { 37 "type": "foo", 38 "name": "foo", 39 "size": 42 40 } 41 }, 42 "email": "foo", 43 "full_name": "foo", 44 "state": "active" 45 }, 46 "modified_date": "2023-01-01T12:00:00.000Z", 47 "stage": { 48 "stage": { 49 "id": "foo", 50 "display_id": "foo", 51 "name": "foo" 52 }, 53 "state": { 54 "id": "foo", 55 "display_id": "foo", 56 "is_final": true, 57 "name": "foo" 58 } 59 }, 60 "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id", 61 "subtype": "foo", 62 "sync_metadata": { 63 "external_reference": "foo", 64 "last_sync_in": { 65 "status": "failed", 66 "sync_date": "2023-01-01T12:00:00.000Z", 67 "sync_unit": { 68 "id": "foo", 69 "display_id": "foo", 70 "external_system_type": "adaas", 71 "is_archived": true, 72 "name": "foo", 73 "sync_run": { 74 "mode": "initial", 75 "progress": { 76 "state": "completed" 77 } 78 }, 79 "sync_type": "manual" 80 } 81 }, 82 "last_sync_out": { 83 "status": "failed", 84 "sync_date": "2023-01-01T12:00:00.000Z", 85 "sync_unit": { 86 "id": "foo", 87 "display_id": "foo", 88 "external_system_type": "adaas", 89 "is_archived": true, 90 "name": "foo", 91 "sync_run": { 92 "mode": "initial", 93 "progress": { 94 "state": "completed" 95 } 96 }, 97 "sync_type": "manual" 98 } 99 }, 100 "origin_system": "foo" 101 }, 102 "title": "foo", 103 "unique_key": "foo" 104 } 105 ], 106 "next_cursor": "foo", 107 "prev_cursor": "foo" 108 }

Lists custom objects.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.

leaf_typestringRequiredformat: "text"

Leaf type to filter.

cursorstringOptionalformat: "text"

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

filterlist of anyOptional

List of filters to apply.

filterslist of anyOptional

List of filters to apply.

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:

sort_bylist of stringsOptional

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

Response

The response to listing all custom objects matching the filter criteria.

resultlist of objects

The custom objects.

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.

Headers

Request

Response

Errors