Get Requirement Template

GET

https://app.brightmove.com/ATS/app/req/template/:reqGk

GET

/ATS/app/req/template/:reqGk

1 import requests
2 
3 url = "https://app.brightmove.com/ATS/app/req/template/1"
4 
5 payload = {}
6 headers = {"Content-Type": "application/json"}
7 
8 response = requests.get(url, json=payload, headers=headers)
9 
10 print(response.json())

1 {
2   "reqGk": 1,
3   "copyFromReqGk": 0,
4   "guid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
5   "reqNumber": "REQ-2026-001",
6   "jobTitle": "Senior Software Engineer",
7   "templateName": "Engineering Template",
8   "openDate": "2026-01-15T08:00:00Z",
9   "endDate": "2026-12-31T17:00:00Z",
10   "duration": "12 months",
11   "location": "New York, NY",
12   "locationAddress": "123 Main St, Suite 400",
13   "locationCity": "New York",
14   "locationState": {
15     "id": 33,
16     "name": "New York",
17     "country": {
18       "id": 1,
19       "name": "United States",
20       "countryCode": "US"
21     },
22     "abbr": "NY"
23   },
24   "locationPostalCode": "10001",
25   "requiredSkills": "Java, Spring Boot, REST APIs",
26   "optionalSkills": "Docker, Kubernetes",
27   "publicDescription": "Looking for a Senior Software Engineer to join our backend team.",
28   "privateDescription": "Candidate must have 5+ years experience in Java development.",
29   "reqStatus": {
30     "id": 2,
31     "name": "Open",
32     "submittable": true
33   },
34   "minBillType": {
35     "id": 1,
36     "name": "Hourly"
37   },
38   "maxBillType": {
39     "id": 1,
40     "name": "Hourly"
41   },
42   "minBillRate": 75,
43   "maxBillRate": 100,
44   "minPayType": {
45     "id": 2,
46     "name": "Salary"
47   },
48   "maxPayType": {
49     "id": 2,
50     "name": "Salary"
51   },
52   "minPayRate": 90000,
53   "maxPayRate": 120000,
54   "bonusPct": 10,
55   "bonusFlat": 5000,
56   "bonusNotes": "Performance-based bonus available.",
57   "openings": 3,
58   "originalOpenings": 3,
59   "createDate": "2026-01-10T09:30:00Z",
60   "createUserGk": 101,
61   "createUserTypeId": 1,
62   "createUser": "jdoe",
63   "createUserGuid": "user-1234-5678-9012-3456",
64   "modifyDate": "2026-01-12T15:45:00Z",
65   "modifyUserGk": 102,
66   "modifyUser": "asmith",
67   "modifyUserGuid": "user-2345-6789-0123-4567",
68   "modifyUserTypeId": 1,
69   "placementType": {
70     "id": 1,
71     "name": "Direct Hire"
72   },
73   "approvalStatus": {
74     "id": 3,
75     "name": "Approved"
76   },
77   "approver": {
78     "userGk": 201,
79     "guid": "approver-5678-1234-9012-3456",
80     "firstName": "Alice",
81     "lastName": "Johnson",
82     "email": "alice.johnson@company.com",
83     "displayFullName": "Alice Johnson",
84     "displayName": "Alice J.",
85     "bestEmail": "alice.johnson@company.com"
86   },
87   "jobGroup": {
88     "id": 5,
89     "name": "Engineering"
90   },
91   "clientJobId": "CL-ENG-2026-001",
92   "statusComment": "Urgent hire",
93   "reqDuration": "12 months",
94   "reqCategories": "Software Development",
95   "reqCategoryId": [
96     101,
97     102
98   ],
99   "feePct": 15,
100   "feeAmt": 15000,
101   "pctChanceClose": 75,
102   "postToInternal": true,
103   "postToWeb": true,
104   "syncDescription": true,
105   "reqLocations": [
106     {
107       "locationGk": 501,
108       "reqGk": 1,
109       "city": "New York",
110       "stateId": 33,
111       "stateName": "New York",
112       "stateAbbr": "NY",
113       "zip": "10001",
114       "county": "New York County",
115       "radius": 25,
116       "distance": 0
117     }
118   ],
119   "reqExams": [
120     301,
121     302
122   ],
123   "clientContact": {
124     "userGk": 401,
125     "guid": "contact-7890-1234-5678-9012",
126     "firstName": "Bob",
127     "lastName": "Williams",
128     "email": "bob.williams@client.com",
129     "displayFullName": "Bob Williams",
130     "displayName": "Bob W.",
131     "bestEmail": "bob.williams@client.com"
132   },
133   "contactName": "Bob Williams",
134   "clientContactGk": 401,
135   "clientContactGuid": "contact-7890-1234-5678-9012",
136   "client": {
137     "guid": "client-1234-5678-9012-3456",
138     "statusId": 1,
139     "clientGk": 1001,
140     "companyName": "Tech Solutions Inc.",
141     "website": "https://www.techsolutions.com",
142     "billAddress1": "456 Corporate Blvd",
143     "billAddress2": "Suite 100",
144     "billCity": "New York",
145     "billState": {
146       "id": 33,
147       "name": "New York",
148       "country": {
149         "id": 1,
150         "name": "United States",
151         "countryCode": "US"
152       },
153       "abbr": "NY"
154     },
155     "billCountry": "USA",
156     "billPostalCode": "10018",
157     "discountPercentage": 5,
158     "discountFee": 500,
159     "companyGk": 2001,
160     "stockSymbol": "TSI",
161     "companyInfo": "Leading provider of software solutions.",
162     "showOverrideEEOC": false,
163     "showUdfSections": true
164   },
165   "clientOfficeGk": 1101,
166   "clientOfficeName": "Tech Solutions NYC Office",
167   "clientOffice": {
168     "officeGk": 1101,
169     "guid": "office-5678-1234-9012-3456",
170     "name": "Tech Solutions NYC Office",
171     "location": {
172       "address1": "456 Corporate Blvd",
173       "address2": "Suite 100",
174       "city": "New York",
175       "state": {
176         "id": 33,
177         "name": "New York",
178         "country": {
179           "id": 1,
180           "name": "United States",
181           "countryCode": "US"
182         },
183         "abbr": "NY"
184       },
185       "postalCode": "10018",
186       "country": {
187         "id": 1,
188         "name": "United States",
189         "countryCode": "US"
190       }
191     },
192     "address": "456 Corporate Blvd, Suite 100",
193     "address2": "Suite 100",
194     "city": "New York",
195     "state": {
196       "id": 33,
197       "name": "New York",
198       "country": {
199         "id": 1,
200         "name": "United States",
201         "countryCode": "US"
202       },
203       "abbr": "NY"
204     },
205     "postalCode": "10018",
206     "primary": true,
207     "statusId": 1
208   },
209   "clientGk": 1001,
210   "clientGuid": "client-1234-5678-9012-3456",
211   "clientOfficeGuid": "office-5678-1234-9012-3456",
212   "clientName": "Tech Solutions Inc.",
213   "clientWebsite": "https://www.techsolutions.com",
214   "reqCategory": {
215     "id": 101,
216     "name": "Software Development"
217   },
218   "statusId": 2,
219   "template": true,
220   "workFromHome": false,
221   "workRemote": false,
222   "workStateWide": false,
223   "workHybrid": true,
224   "editable": true,
225   "claimed": false,
226   "numSubmittals": 0,
227   "hasContactAccess": true,
228   "lineItemGuid": "lineitem-1234-5678-9012-3456",
229   "userCanApprove": true,
230   "portalGk": 3001,
231   "portalName": "BrightMove Portal",
232   "partTime": false,
233   "openGraphImage": "https://cdn.brightmove.com/images/job-open-graph.png",
234   "productPayPlan": null,
235   "interviewSchedule": null,
236   "reqRecruiterList": [
237     "jdoe",
238     "asmith"
239   ],
240   "workgroupList": [],
241   "jobCategoryList": [
242     101,
243     102
244   ],
245   "jobIndustryList": [
246     201,
247     202
248   ],
249   "jobFunctionList": [
250     301,
251     302
252   ],
253   "udfSections": [],
254   "jobBoards": [],
255   "recruiters": [],
256   "claimUsers": [],
257   "tags": [],
258   "salesUser": null,
259   "sourcers": [],
260   "workgroups": [],
261   "vendors": [],
262   "categories": [],
263   "functions": [],
264   "industries": [],
265   "maxOte": 130000,
266   "minOte": 90000
267 }

Get a Requirement template

Path parameters

reqGklongRequired

Get Requirement Template

Path parameters

Headers

Response