List Custom Objects

GET

Lists custom objects.

Query parameters

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.

limitintegerOptional

The maximum number of items.

modeenumOptional

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

Allowed values: afterbefore

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_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

GET

1 curl -G https://api.devrev.ai/custom-objects.list \
2      -H "Authorization: Bearer <token>" \
3      -d leaf_type=leaf_type

200Retrieved

1 {
2   "result": [
3     {
4       "id": "id",
5       "created_by": {
6         "type": "dev_user",
7         "id": "id",
8         "display_id": "display_id",
9         "display_name": "display_name",
10         "display_picture": {
11           "id": "id",
12           "file": {}
13         },
14         "email": "email",
15         "full_name": "full_name",
16         "state": "active"
17       },
18       "created_date": "created_date",
19       "custom_fields": {},
20       "custom_schema_fragments": [
21         "custom_schema_fragments",
22         "custom_schema_fragments"
23       ],
24       "display_id": "display_id",
25       "modified_by": {
26         "type": "dev_user",
27         "id": "id",
28         "display_id": "display_id",
29         "display_name": "display_name",
30         "display_picture": {
31           "id": "id",
32           "file": {}
33         },
34         "email": "email",
35         "full_name": "full_name",
36         "state": "active"
37       },
38       "modified_date": "modified_date",
39       "stock_schema_fragment": "stock_schema_fragment",
40       "subtype": "subtype",
41       "sync_metadata": {
42         "external_reference": "external_reference",
43         "last_sync_in": {
44           "status": "failed",
45           "sync_date": "sync_date",
46           "sync_unit": {
47             "id": "id",
48             "external_system_type": "adaas",
49             "is_archived": true,
50             "name": "name",
51             "sync_run": {},
52             "sync_type": "manual"
53           }
54         },
55         "last_sync_out": {
56           "status": "failed",
57           "sync_date": "sync_date",
58           "sync_unit": {
59             "id": "id",
60             "external_system_type": "adaas",
61             "is_archived": true,
62             "name": "name",
63             "sync_run": {},
64             "sync_type": "manual"
65           }
66         },
67         "origin_system": "origin_system"
68       }
69     },
70     {
71       "id": "id",
72       "created_by": {
73         "type": "dev_user",
74         "id": "id",
75         "display_id": "display_id",
76         "display_name": "display_name",
77         "display_picture": {
78           "id": "id",
79           "file": {}
80         },
81         "email": "email",
82         "full_name": "full_name",
83         "state": "active"
84       },
85       "created_date": "created_date",
86       "custom_fields": {},
87       "custom_schema_fragments": [
88         "custom_schema_fragments",
89         "custom_schema_fragments"
90       ],
91       "display_id": "display_id",
92       "modified_by": {
93         "type": "dev_user",
94         "id": "id",
95         "display_id": "display_id",
96         "display_name": "display_name",
97         "display_picture": {
98           "id": "id",
99           "file": {}
100         },
101         "email": "email",
102         "full_name": "full_name",
103         "state": "active"
104       },
105       "modified_date": "modified_date",
106       "stock_schema_fragment": "stock_schema_fragment",
107       "subtype": "subtype",
108       "sync_metadata": {
109         "external_reference": "external_reference",
110         "last_sync_in": {
111           "status": "failed",
112           "sync_date": "sync_date",
113           "sync_unit": {
114             "id": "id",
115             "external_system_type": "adaas",
116             "is_archived": true,
117             "name": "name",
118             "sync_run": {},
119             "sync_type": "manual"
120           }
121         },
122         "last_sync_out": {
123           "status": "failed",
124           "sync_date": "sync_date",
125           "sync_unit": {
126             "id": "id",
127             "external_system_type": "adaas",
128             "is_archived": true,
129             "name": "name",
130             "sync_run": {},
131             "sync_type": "manual"
132           }
133         },
134         "origin_system": "origin_system"
135       }
136     }
137   ],
138   "next_cursor": "next_cursor",
139   "prev_cursor": "prev_cursor"
140 }

List Custom Objects (POST)

Up Next

Built with

1	curl -G https://api.devrev.ai/custom-objects.list \
2	-H "Authorization: Bearer <token>" \
3	-d leaf_type=leaf_type

1	{
2	"result": [
3	{
4	"id": "id",
5	"created_by": {
6	"type": "dev_user",
7	"id": "id",
8	"display_id": "display_id",
9	"display_name": "display_name",
10	"display_picture": {
11	"id": "id",
12	"file": {}
13	},
14	"email": "email",
15	"full_name": "full_name",
16	"state": "active"
17	},
18	"created_date": "created_date",
19	"custom_fields": {},
20	"custom_schema_fragments": [
21	"custom_schema_fragments",
22	"custom_schema_fragments"
23	],
24	"display_id": "display_id",
25	"modified_by": {
26	"type": "dev_user",
27	"id": "id",
28	"display_id": "display_id",
29	"display_name": "display_name",
30	"display_picture": {
31	"id": "id",
32	"file": {}
33	},
34	"email": "email",
35	"full_name": "full_name",
36	"state": "active"
37	},
38	"modified_date": "modified_date",
39	"stock_schema_fragment": "stock_schema_fragment",
40	"subtype": "subtype",
41	"sync_metadata": {
42	"external_reference": "external_reference",
43	"last_sync_in": {
44	"status": "failed",
45	"sync_date": "sync_date",
46	"sync_unit": {
47	"id": "id",
48	"external_system_type": "adaas",
49	"is_archived": true,
50	"name": "name",
51	"sync_run": {},
52	"sync_type": "manual"
53	}
54	},
55	"last_sync_out": {
56	"status": "failed",
57	"sync_date": "sync_date",
58	"sync_unit": {
59	"id": "id",
60	"external_system_type": "adaas",
61	"is_archived": true,
62	"name": "name",
63	"sync_run": {},
64	"sync_type": "manual"
65	}
66	},
67	"origin_system": "origin_system"
68	}
69	},
70	{
71	"id": "id",
72	"created_by": {
73	"type": "dev_user",
74	"id": "id",
75	"display_id": "display_id",
76	"display_name": "display_name",
77	"display_picture": {
78	"id": "id",
79	"file": {}
80	},
81	"email": "email",
82	"full_name": "full_name",
83	"state": "active"
84	},
85	"created_date": "created_date",
86	"custom_fields": {},
87	"custom_schema_fragments": [
88	"custom_schema_fragments",
89	"custom_schema_fragments"
90	],
91	"display_id": "display_id",
92	"modified_by": {
93	"type": "dev_user",
94	"id": "id",
95	"display_id": "display_id",
96	"display_name": "display_name",
97	"display_picture": {
98	"id": "id",
99	"file": {}
100	},
101	"email": "email",
102	"full_name": "full_name",
103	"state": "active"
104	},
105	"modified_date": "modified_date",
106	"stock_schema_fragment": "stock_schema_fragment",
107	"subtype": "subtype",
108	"sync_metadata": {
109	"external_reference": "external_reference",
110	"last_sync_in": {
111	"status": "failed",
112	"sync_date": "sync_date",
113	"sync_unit": {
114	"id": "id",
115	"external_system_type": "adaas",
116	"is_archived": true,
117	"name": "name",
118	"sync_run": {},
119	"sync_type": "manual"
120	}
121	},
122	"last_sync_out": {
123	"status": "failed",
124	"sync_date": "sync_date",
125	"sync_unit": {
126	"id": "id",
127	"external_system_type": "adaas",
128	"is_archived": true,
129	"name": "name",
130	"sync_run": {},
131	"sync_type": "manual"
132	}
133	},
134	"origin_system": "origin_system"
135	}
136	}
137	],
138	"next_cursor": "next_cursor",
139	"prev_cursor": "prev_cursor"
140	}