Find Requirements By Query

POST

Get the List of Requirements based on search query

Headers

X-Brightmove-User-ApiKeystringRequired

Request

This endpoint expects an object.

queryStringstringOptional

displayFieldsstringOptional

sortStringstringOptional

searchDeletedbooleanOptional

pageSizeenumOptional

pageNumberintegerOptional

Response

resultslist of objectsOptional

querystringOptional

resultsFoundlongOptional

pagesintegerOptional

startRecordintegerOptional

endRecordintegerOptional

currPageintegerOptional

highlightmap from strings to maps from strings to lists of stringsOptional

pagedKeyslist of longsOptional

csvstringOptional

qtimeintegerOptional

POST

1 curl -X POST https://app.brightmove.com/ATS/app/req/find \
2      -H "Content-Type: application/json" \
3      -d '{}'

200Successful

1 {
2   "results": [
3     {
4       "reqGk": "reqGk",
5       "guid": "guid",
6       "jobTitle": "jobTitle",
7       "score": 1.1,
8       "statusId": 1000000,
9       "statusName": "statusName",
10       "statusComment": "statusComment",
11       "postToWeb": true,
12       "partTime": true,
13       "displayPostToWeb": "displayPostToWeb",
14       "displayPostToInternal": "displayPostToInternal",
15       "postToInternal": true,
16       "clientContactGk": 1000000,
17       "clientContactGuid": "clientContactGuid",
18       "clientContactName": "clientContactName",
19       "clientContactFirstName": "clientContactFirstName",
20       "clientContactLastName": "clientContactLastName",
21       "clientContactAssignGk": [
22         1000000
23       ],
24       "clientGk": 1000000,
25       "clientGuid": "clientGuid",
26       "companyName": "companyName",
27       "displayOpenDate": "displayOpenDate",
28       "openDate": "2024-01-15T09:30:00Z",
29       "location": "location",
30       "publicDesc": "publicDesc",
31       "privateDesc": "privateDesc",
32       "requiredSkills": "requiredSkills",
33       "optionalSkills": "optionalSkills",
34       "minPayRate": 1.1,
35       "minPayTypeId": 1,
36       "minPayTypeName": "minPayTypeName",
37       "maxPayRate": 1.1,
38       "maxPayTypeId": 1,
39       "maxPayTypeName": "maxPayTypeName",
40       "companyGk": 1000000,
41       "locationCity": [
42         "locationCity"
43       ],
44       "locationStateId": [
45         1
46       ],
47       "submittals": 1,
48       "locationStateName": [
49         "locationStateName"
50       ],
51       "locationStateAbbr": [
52         "locationStateAbbr"
53       ],
54       "locationZip": [
55         "locationZip"
56       ],
57       "locationCountry": "locationCountry",
58       "duration": "duration",
59       "reqNumber": "reqNumber",
60       "reqStatName": "reqStatName",
61       "latLon": [
62         "latLon"
63       ],
64       "jobGroupGk": 1000000,
65       "jobGroupName": "jobGroupName",
66       "overrideEEOC": true,
67       "reqStatId": 1,
68       "modifyDate": "2024-01-15T09:30:00Z",
69       "displayModifyDate": "displayModifyDate",
70       "createDate": "2024-01-15T09:30:00Z",
71       "displayCreateDate": "displayCreateDate",
72       "createUser": "createUser",
73       "createUserGk": 1000000,
74       "createUserGuid": "createUserGuid",
75       "createUserType": 1,
76       "modifyUser": "modifyUser",
77       "modifyUserGk": 1000000,
78       "modifyUserType": 1,
79       "modifyUserGuid": "modifyUserGuid",
80       "placementTypeId": 1000000,
81       "openings": 1,
82       "feeAmount": 1.1,
83       "feePercentage": 1.1,
84       "percentageChanceClose": 1.1,
85       "placementTypeName": "placementTypeName",
86       "salesUser": "salesUser",
87       "salesUserGk": 1000000,
88       "securityEmployeeGk": 1000000,
89       "tags": [
90         "tags"
91       ],
92       "requirementCategory": [
93         1000000
94       ],
95       "sourcer": [
96         "sourcer"
97       ],
98       "requirementCategoryName": [
99         "requirementCategoryName"
100       ],
101       "workgroupGk": [
102         1000000
103       ],
104       "recruiterGk": [
105         1000000
106       ],
107       "recruiterName": [
108         "recruiterName"
109       ],
110       "requirementVendor": [
111         1000000
112       ],
113       "portalClient": [
114         1000000
115       ],
116       "portalClientName": [
117         "portalClientName"
118       ],
119       "folderGk": [
120         1000000
121       ],
122       "folderName": [
123         "folderName"
124       ],
125       "clientOfficeGk": 1000000,
126       "clientOfficeGuid": "clientOfficeGuid",
127       "clientOfficeName": "clientOfficeName",
128       "substatGk": [
129         1000000
130       ],
131       "submittalCount": [
132         1000000
133       ],
134       "submittalsFilter": [
135         "submittalsFilter"
136       ],
137       "submittable": true,
138       "workFromHome": true,
139       "workRemote": true,
140       "workHybrid": true,
141       "displaySubmittable": "displaySubmittable",
142       "udfMap": {
143         "key": "value"
144       },
145       "legacyId": "legacyId",
146       "securityClientContactApproverGk": [
147         1000000
148       ],
149       "securityClientContactAccessGk": [
150         1000000
151       ],
152       "securityClientWorkgroupGk": [
153         1000000
154       ]
155     }
156   ],
157   "query": "query",
158   "resultsFound": 1000000,
159   "pages": 1,
160   "startRecord": 1,
161   "endRecord": 1,
162   "currPage": 1,
163   "highlight": {
164     "key": {
165       "key": [
166         "value"
167       ]
168     }
169   },
170   "pagedKeys": [
171     1000000
172   ],
173   "csv": "csv",
174   "qtime": 1
175 }

Get Rate Card

Up Next

Built with

1	curl -X POST https://app.brightmove.com/ATS/app/req/find \
2	-H "Content-Type: application/json" \
3	-d '{}'

1	{
2	"results": [
3	{
4	"reqGk": "reqGk",
5	"guid": "guid",
6	"jobTitle": "jobTitle",
7	"score": 1.1,
8	"statusId": 1000000,
9	"statusName": "statusName",
10	"statusComment": "statusComment",
11	"postToWeb": true,
12	"partTime": true,
13	"displayPostToWeb": "displayPostToWeb",
14	"displayPostToInternal": "displayPostToInternal",
15	"postToInternal": true,
16	"clientContactGk": 1000000,
17	"clientContactGuid": "clientContactGuid",
18	"clientContactName": "clientContactName",
19	"clientContactFirstName": "clientContactFirstName",
20	"clientContactLastName": "clientContactLastName",
21	"clientContactAssignGk": [
22	1000000
23	],
24	"clientGk": 1000000,
25	"clientGuid": "clientGuid",
26	"companyName": "companyName",
27	"displayOpenDate": "displayOpenDate",
28	"openDate": "2024-01-15T09:30:00Z",
29	"location": "location",
30	"publicDesc": "publicDesc",
31	"privateDesc": "privateDesc",
32	"requiredSkills": "requiredSkills",
33	"optionalSkills": "optionalSkills",
34	"minPayRate": 1.1,
35	"minPayTypeId": 1,
36	"minPayTypeName": "minPayTypeName",
37	"maxPayRate": 1.1,
38	"maxPayTypeId": 1,
39	"maxPayTypeName": "maxPayTypeName",
40	"companyGk": 1000000,
41	"locationCity": [
42	"locationCity"
43	],
44	"locationStateId": [
45	1
46	],
47	"submittals": 1,
48	"locationStateName": [
49	"locationStateName"
50	],
51	"locationStateAbbr": [
52	"locationStateAbbr"
53	],
54	"locationZip": [
55	"locationZip"
56	],
57	"locationCountry": "locationCountry",
58	"duration": "duration",
59	"reqNumber": "reqNumber",
60	"reqStatName": "reqStatName",
61	"latLon": [
62	"latLon"
63	],
64	"jobGroupGk": 1000000,
65	"jobGroupName": "jobGroupName",
66	"overrideEEOC": true,
67	"reqStatId": 1,
68	"modifyDate": "2024-01-15T09:30:00Z",
69	"displayModifyDate": "displayModifyDate",
70	"createDate": "2024-01-15T09:30:00Z",
71	"displayCreateDate": "displayCreateDate",
72	"createUser": "createUser",
73	"createUserGk": 1000000,
74	"createUserGuid": "createUserGuid",
75	"createUserType": 1,
76	"modifyUser": "modifyUser",
77	"modifyUserGk": 1000000,
78	"modifyUserType": 1,
79	"modifyUserGuid": "modifyUserGuid",
80	"placementTypeId": 1000000,
81	"openings": 1,
82	"feeAmount": 1.1,
83	"feePercentage": 1.1,
84	"percentageChanceClose": 1.1,
85	"placementTypeName": "placementTypeName",
86	"salesUser": "salesUser",
87	"salesUserGk": 1000000,
88	"securityEmployeeGk": 1000000,
89	"tags": [
90	"tags"
91	],
92	"requirementCategory": [
93	1000000
94	],
95	"sourcer": [
96	"sourcer"
97	],
98	"requirementCategoryName": [
99	"requirementCategoryName"
100	],
101	"workgroupGk": [
102	1000000
103	],
104	"recruiterGk": [
105	1000000
106	],
107	"recruiterName": [
108	"recruiterName"
109	],
110	"requirementVendor": [
111	1000000
112	],
113	"portalClient": [
114	1000000
115	],
116	"portalClientName": [
117	"portalClientName"
118	],
119	"folderGk": [
120	1000000
121	],
122	"folderName": [
123	"folderName"
124	],
125	"clientOfficeGk": 1000000,
126	"clientOfficeGuid": "clientOfficeGuid",
127	"clientOfficeName": "clientOfficeName",
128	"substatGk": [
129	1000000
130	],
131	"submittalCount": [
132	1000000
133	],
134	"submittalsFilter": [
135	"submittalsFilter"
136	],
137	"submittable": true,
138	"workFromHome": true,
139	"workRemote": true,
140	"workHybrid": true,
141	"displaySubmittable": "displaySubmittable",
142	"udfMap": {
143	"key": "value"
144	},
145	"legacyId": "legacyId",
146	"securityClientContactApproverGk": [
147	1000000
148	],
149	"securityClientContactAccessGk": [
150	1000000
151	],
152	"securityClientWorkgroupGk": [
153	1000000
154	]
155	}
156	],
157	"query": "query",
158	"resultsFound": 1000000,
159	"pages": 1,
160	"startRecord": 1,
161	"endRecord": 1,
162	"currPage": 1,
163	"highlight": {
164	"key": {
165	"key": [
166	"value"
167	]
168	}
169	},
170	"pagedKeys": [
171	1000000
172	],
173	"csv": "csv",
174	"qtime": 1
175	}