Core Search (POST)

POST

Searches for records based on a given query.

Request

This endpoint expects an object.

querystringRequiredformat: "text"

The query string. Search query language: https://docs.devrev.ai/product/search#fields

cursorstringOptionalformat: "text"

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

limitintegerOptional

The maximum number of items to return in a page. The default is ‘10’.

modeenumOptional

Allowed values: afterbefore

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.

namespaceslist of enumsOptional

The namespaces to search in.

sort_byenumOptional

Allowed values: created_datemodified_daterelevance

Search sort by parameters.

sort_orderenumOptional

Allowed values: ascdesc

Search sort order parameters.

Response

Search response.

resultslist of objects

The search results.

cursorstringOptionalformat: "text"

The cursor from where to begin iteration. Start from beginning if not provided.

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.

POST

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

200Successful

1 {
2   "results": [
3     {
4       "type": "account",
5       "account": {
6         "id": "id",
7         "display_id": "display_id",
8         "display_name": "display_name"
9       },
10       "comments": [
11         {
12           "comment": {
13             "id": "id",
14             "sync_metadata": {}
15           },
16           "created_by": {
17             "type": "dev_user",
18             "id": "id",
19             "display_name": "display_name",
20             "display_picture": {},
21             "email": "email",
22             "full_name": "full_name",
23             "state": "active"
24           },
25           "created_date": "created_date",
26           "object": "object",
27           "panels": [
28             "alerts",
29             "alerts"
30           ],
31           "references": [
32             {
33               "type": "account"
34             },
35             {
36               "type": "account"
37             }
38           ],
39           "snippet": "snippet"
40         },
41         {
42           "comment": {
43             "id": "id",
44             "sync_metadata": {}
45           },
46           "created_by": {
47             "type": "dev_user",
48             "id": "id",
49             "display_name": "display_name",
50             "display_picture": {},
51             "email": "email",
52             "full_name": "full_name",
53             "state": "active"
54           },
55           "created_date": "created_date",
56           "object": "object",
57           "panels": [
58             "alerts",
59             "alerts"
60           ],
61           "references": [
62             {
63               "type": "account"
64             },
65             {
66               "type": "account"
67             }
68           ],
69           "snippet": "snippet"
70         }
71       ],
72       "modified_date": "modified_date",
73       "snippet": "snippet"
74     },
75     {
76       "type": "account",
77       "account": {
78         "id": "id",
79         "display_id": "display_id",
80         "display_name": "display_name"
81       },
82       "comments": [
83         {
84           "comment": {
85             "id": "id",
86             "sync_metadata": {}
87           },
88           "created_by": {
89             "type": "dev_user",
90             "id": "id",
91             "display_name": "display_name",
92             "display_picture": {},
93             "email": "email",
94             "full_name": "full_name",
95             "state": "active"
96           },
97           "created_date": "created_date",
98           "object": "object",
99           "panels": [
100             "alerts",
101             "alerts"
102           ],
103           "references": [
104             {
105               "type": "account"
106             },
107             {
108               "type": "account"
109             }
110           ],
111           "snippet": "snippet"
112         },
113         {
114           "comment": {
115             "id": "id",
116             "sync_metadata": {}
117           },
118           "created_by": {
119             "type": "dev_user",
120             "id": "id",
121             "display_name": "display_name",
122             "display_picture": {},
123             "email": "email",
124             "full_name": "full_name",
125             "state": "active"
126           },
127           "created_date": "created_date",
128           "object": "object",
129           "panels": [
130             "alerts",
131             "alerts"
132           ],
133           "references": [
134             {
135               "type": "account"
136             },
137             {
138               "type": "account"
139             }
140           ],
141           "snippet": "snippet"
142         }
143       ],
144       "modified_date": "modified_date",
145       "snippet": "snippet"
146     }
147   ],
148   "cursor": "cursor",
149   "next_cursor": "next_cursor",
150   "prev_cursor": "prev_cursor"
151 }

Hybrid Search

Up Next

Built with

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

1	{
2	"results": [
3	{
4	"type": "account",
5	"account": {
6	"id": "id",
7	"display_id": "display_id",
8	"display_name": "display_name"
9	},
10	"comments": [
11	{
12	"comment": {
13	"id": "id",
14	"sync_metadata": {}
15	},
16	"created_by": {
17	"type": "dev_user",
18	"id": "id",
19	"display_name": "display_name",
20	"display_picture": {},
21	"email": "email",
22	"full_name": "full_name",
23	"state": "active"
24	},
25	"created_date": "created_date",
26	"object": "object",
27	"panels": [
28	"alerts",
29	"alerts"
30	],
31	"references": [
32	{
33	"type": "account"
34	},
35	{
36	"type": "account"
37	}
38	],
39	"snippet": "snippet"
40	},
41	{
42	"comment": {
43	"id": "id",
44	"sync_metadata": {}
45	},
46	"created_by": {
47	"type": "dev_user",
48	"id": "id",
49	"display_name": "display_name",
50	"display_picture": {},
51	"email": "email",
52	"full_name": "full_name",
53	"state": "active"
54	},
55	"created_date": "created_date",
56	"object": "object",
57	"panels": [
58	"alerts",
59	"alerts"
60	],
61	"references": [
62	{
63	"type": "account"
64	},
65	{
66	"type": "account"
67	}
68	],
69	"snippet": "snippet"
70	}
71	],
72	"modified_date": "modified_date",
73	"snippet": "snippet"
74	},
75	{
76	"type": "account",
77	"account": {
78	"id": "id",
79	"display_id": "display_id",
80	"display_name": "display_name"
81	},
82	"comments": [
83	{
84	"comment": {
85	"id": "id",
86	"sync_metadata": {}
87	},
88	"created_by": {
89	"type": "dev_user",
90	"id": "id",
91	"display_name": "display_name",
92	"display_picture": {},
93	"email": "email",
94	"full_name": "full_name",
95	"state": "active"
96	},
97	"created_date": "created_date",
98	"object": "object",
99	"panels": [
100	"alerts",
101	"alerts"
102	],
103	"references": [
104	{
105	"type": "account"
106	},
107	{
108	"type": "account"
109	}
110	],
111	"snippet": "snippet"
112	},
113	{
114	"comment": {
115	"id": "id",
116	"sync_metadata": {}
117	},
118	"created_by": {
119	"type": "dev_user",
120	"id": "id",
121	"display_name": "display_name",
122	"display_picture": {},
123	"email": "email",
124	"full_name": "full_name",
125	"state": "active"
126	},
127	"created_date": "created_date",
128	"object": "object",
129	"panels": [
130	"alerts",
131	"alerts"
132	],
133	"references": [
134	{
135	"type": "account"
136	},
137	{
138	"type": "account"
139	}
140	],
141	"snippet": "snippet"
142	}
143	],
144	"modified_date": "modified_date",
145	"snippet": "snippet"
146	}
147	],
148	"cursor": "cursor",
149	"next_cursor": "next_cursor",
150	"prev_cursor": "prev_cursor"
151	}