Get a Placement

GET

Get a Placement

Path parameters

guidstringRequired

Headers

X-Brightmove-User-ApiKeystringRequired

Response

applicantslist of objectsOptional

reqGklongOptional

guidstringOptional

reqGuidstringOptional

jobTitlestringOptional

applicantGklongOptional

applicantGuidstringOptional

applicantstringOptional

placementTypeobjectOptional

recruiterGklongOptional

recruiterGuidstringOptional

recruiterstringOptional

clientContactGklongOptional

clientContactGuidstringOptional

clientContactstringOptional

clientGklongOptional

clientGuidstringOptional

clientNamestringOptional

officeGklongOptional

officeGuidstringOptional

officeNamestringOptional

startDatedatetimeOptional

endDatedatetimeOptional

hireDatedatetimeOptional

commissionEndDatedatetimeOptional

commissionFeedoubleOptional

commissionPctdoubleOptional

guaranteestringOptional

billRatedoubleOptional

billTypeobjectOptional

payRatedoubleOptional

payTypeobjectOptional

conversionFeedoubleOptional

directFeePctdoubleOptional

directFeeFlatdoubleOptional

bonusPctdoubleOptional

bonusFlatdoubleOptional

bonusNotesstringOptional

mboPctdoubleOptional

mboFlatdoubleOptional

mboNotesstringOptional

employmentTypeobjectOptional

emplCostValuedoubleOptional

emplCostPercentagedoubleOptional

clientFeedoubleOptional

clientDiscountdoubleOptional

currentPlacementbooleanOptional

createUserstringOptional

createUserGklongOptional

createDatedatetimeOptional

modifyUserstringOptional

modifyUserGklongOptional

modifyDatedatetimeOptional

newPlacementbooleanOptional

updateProductPayPlanbooleanOptional

placementProductobjectOptional

udfSectionslist of objectsOptional

emplCostPctAmountdoubleOptional

hourlyPayRatedoubleOptional

emplTotalCostdoubleOptional

hourlyBillRatedoubleOptional

clientDiscountAmountdoubleOptional

realizedBillRatedoubleOptional

netSpreaddoubleOptional

netProfitMargindoubleOptional

commissionAmountdoubleOptional

commissionPctAmountdoubleOptional

directFeeAmountdoubleOptional

directNetProfitdoubleOptional

directNetProfitMargindoubleOptional

totalDirectFeesdoubleOptional

displayHourlyPayRatestringOptional

displayEmplCostValuestringOptional

displayEmplCostPctstringOptional

displayEmplCostPctAmountstringOptional

displayEmplTotalCoststringOptional

displayClientFeestringOptional

displayClientDiscountstringOptional

displayClientDiscountAmountstringOptional

displayHourlyBillRatestringOptional

displayRealizedBillRatestringOptional

displayNetSpreadstringOptional

displayNetProfitMarginstringOptional

displayBillRatestringOptional

displayBonusFlatstringOptional

displayBonusPctstringOptional

displayCommissionAmountstringOptional

displayCommissionFeestringOptional

displayCommissionPctstringOptional

displayCommissionPctAmountstringOptional

displayDirectFeeAmountstringOptional

displayDirectFeeFlatstringOptional

displayDirectFeePctstringOptional

displayDirectNetProfitstringOptional

displayDirectNetProfitMarginstringOptional

displayMboFlatstringOptional

displayMboPctstringOptional

displayPayRatestringOptional

displayTotalDirectFeesstringOptional

displayCommissionEndDatestringOptional

displayHireDatestringOptional

displayStartDatestringOptional

displayEndDatestringOptional

GET

1 curl https://app.brightmove.com/ATS/app/submittal/placement/guid

200Retrieved

1 {
2   "applicants": [
3     {
4       "userGk": 1000000,
5       "guid": "guid",
6       "salutation": {
7         "id": 1000000
8       },
9       "firstName": "firstName",
10       "middleName": "middleName",
11       "lastName": "lastName",
12       "nickname": "nickname",
13       "email": "email",
14       "workEmail": "workEmail",
15       "companyGk": 1000000,
16       "companyName": "companyName",
17       "companyGuid": "companyGuid",
18       "createUserGk": 1000000,
19       "modifyUserGk": 1000000,
20       "username": "username",
21       "avatarUrl": "avatarUrl",
22       "timezoneId": 1,
23       "localeId": 1,
24       "statusId": 1,
25       "phones": [
26         {}
27       ],
28       "primary": true,
29       "createDate": "2024-01-15T09:30:00Z",
30       "modifyDate": "2024-01-15T09:30:00Z",
31       "themeGk": 1000000,
32       "lookDate": "2024-01-15T09:30:00Z",
33       "unsubscribeDate": "2024-01-15T09:30:00Z",
34       "delegates": [
35         {}
36       ],
37       "emailSignature": "emailSignature",
38       "address": "address",
39       "address2": "address2",
40       "city": "city",
41       "state": {
42         "id": 1000000
43       },
44       "postalCode": "postalCode",
45       "status": {
46         "id": 1000000
47       },
48       "employmentType": {
49         "id": 1000000
50       },
51       "emailAllowed": true,
52       "smsAllowed": true,
53       "doNotHire": true,
54       "preferredLocation": "preferredLocation",
55       "availableDate": "2024-01-15T09:30:00Z",
56       "availabilityComments": "availabilityComments",
57       "referredBy": "referredBy",
58       "currentCompany": "currentCompany",
59       "currentTitle": "currentTitle",
60       "currentPay": 1.1,
61       "currentPayType": {
62         "id": 1000000
63       },
64       "desiredPay": 1.1,
65       "desiredPayType": {
66         "id": 1000000
67       },
68       "payComments": "payComments",
69       "taxId": 1,
70       "dob": "2024-01-15T09:30:00Z",
71       "disabilityStatus": {
72         "id": 1000000
73       },
74       "currentEmployee": true,
75       "sourceOther": "sourceOther",
76       "rank": 1,
77       "primarySkills": "primarySkills",
78       "gender": {
79         "id": 1000000
80       },
81       "raceEthnicity": {
82         "id": 1000000
83       },
84       "veteranStatus": {
85         "id": 1000000
86       },
87       "workPermit": {
88         "id": 1000000
89       },
90       "newResume": true,
91       "confidential": true,
92       "resumes": [
93         {
94           "name": "name",
95           "content": "content"
96         }
97       ],
98       "udfSections": [
99         {}
100       ],
101       "employmentHistory": [
102         {}
103       ],
104       "education": [
105         {}
106       ],
107       "employer": "employer",
108       "applStatName": "applStatName",
109       "title": "title",
110       "statusNote": "statusNote",
111       "socialLinks": [
112         {}
113       ],
114       "ownedByMasterCompany": true,
115       "linkClientContactGk": 1000000,
116       "tags": [
117         {}
118       ],
119       "personalData": {
120         "id": 1000000
121       },
122       "sensitiveData": {
123         "id": 1000000
124       },
125       "duplicate": true,
126       "attachments": [
127         {
128           "filedata": [
129             "PEJhc2U2NCBFbmNvZGVkIEZpbGUgRGF0YT4="
130           ],
131           "filename": "Ponce_DeLeon_Resume.pdf",
132           "guid": "UUUUUUUU-VVVV-XXXX-YYYY-ZZZZZZZZZZZZ",
133           "compressed": true,
134           "attachGk": 123456,
135           "createDate": "2018-08-23T11:20:29Z",
136           "createUserGk": 123456,
137           "createUser": "Aldonza Alfonso",
138           "description": "Resume in word format, sent by applicant.",
139           "filetype": "aplication/pdf",
140           "filesize": 65536,
141           "publicView": true,
142           "clientContract": true,
143           "basicQualification": true,
144           "interview": true,
145           "attached": true,
146           "displayCreateDate": "08/23/2018 11:20:29 AM"
147         }
148       ],
149       "override": true,
150       "visitorId": "visitorId",
151       "ssn": "ssn",
152       "name": "name",
153       "displayFullName": "displayFullName",
154       "displayNameLastFirst": "displayNameLastFirst",
155       "bestEmail": "bestEmail",
156       "displayName": "displayName"
157     }
158   ],
159   "reqGk": 1000000,
160   "guid": "guid",
161   "reqGuid": "reqGuid",
162   "jobTitle": "jobTitle",
163   "applicantGk": 1000000,
164   "applicantGuid": "applicantGuid",
165   "applicant": "applicant",
166   "placementType": {
167     "id": 1000000,
168     "name": "name"
169   },
170   "recruiterGk": 1000000,
171   "recruiterGuid": "recruiterGuid",
172   "recruiter": "recruiter",
173   "clientContactGk": 1000000,
174   "clientContactGuid": "clientContactGuid",
175   "clientContact": "clientContact",
176   "clientGk": 1000000,
177   "clientGuid": "clientGuid",
178   "clientName": "clientName",
179   "officeGk": 1000000,
180   "officeGuid": "officeGuid",
181   "officeName": "officeName",
182   "startDate": "2024-01-15T09:30:00Z",
183   "endDate": "2024-01-15T09:30:00Z",
184   "hireDate": "2024-01-15T09:30:00Z",
185   "commissionEndDate": "2024-01-15T09:30:00Z",
186   "commissionFee": 1.1,
187   "commissionPct": 1.1,
188   "guarantee": "guarantee",
189   "billRate": 1.1,
190   "billType": {
191     "id": 1000000,
192     "name": "name"
193   },
194   "payRate": 1.1,
195   "payType": {
196     "id": 1000000,
197     "name": "name"
198   },
199   "conversionFee": 1.1,
200   "directFeePct": 1.1,
201   "directFeeFlat": 1.1,
202   "bonusPct": 1.1,
203   "bonusFlat": 1.1,
204   "bonusNotes": "bonusNotes",
205   "mboPct": 1.1,
206   "mboFlat": 1.1,
207   "mboNotes": "mboNotes",
208   "employmentType": {
209     "id": 1000000,
210     "name": "name",
211     "costValue": 1.1,
212     "costPercentage": 1.1,
213     "sortOrder": 1,
214     "rate": 1.1
215   },
216   "emplCostValue": 1.1,
217   "emplCostPercentage": 1.1,
218   "clientFee": 1.1,
219   "clientDiscount": 1.1,
220   "currentPlacement": true,
221   "createUser": "createUser",
222   "createUserGk": 1000000,
223   "createDate": "2024-01-15T09:30:00Z",
224   "modifyUser": "modifyUser",
225   "modifyUserGk": 1000000,
226   "modifyDate": "2024-01-15T09:30:00Z",
227   "newPlacement": true,
228   "updateProductPayPlan": true,
229   "placementProduct": {
230     "payPlan": {
231       "productPayPlanGk": 1000000,
232       "guid": "guid",
233       "name": "name",
234       "description": "description",
235       "retainerModifier": 1.1,
236       "sortOrder": 1,
237       "createDate": "2024-01-15T09:30:00Z",
238       "modifyDate": "2024-01-15T09:30:00Z",
239       "clientOfficeGk": 1000000,
240       "clientGk": 1000000,
241       "childCompanyGk": 1000000,
242       "productPayPlanLines": [
243         {}
244       ],
245       "assigned": true,
246       "invoiced": true
247     }
248   },
249   "udfSections": [
250     {
251       "sectionGk": 1000000,
252       "sectionName": "sectionName",
253       "sortOrder": 1,
254       "fields": [
255         {}
256       ],
257       "fieldGk": 1000000,
258       "entityTypes": [
259         "1"
260       ]
261     }
262   ],
263   "emplCostPctAmount": 1.1,
264   "hourlyPayRate": 1.1,
265   "emplTotalCost": 1.1,
266   "hourlyBillRate": 1.1,
267   "clientDiscountAmount": 1.1,
268   "realizedBillRate": 1.1,
269   "netSpread": 1.1,
270   "netProfitMargin": 1.1,
271   "commissionAmount": 1.1,
272   "commissionPctAmount": 1.1,
273   "directFeeAmount": 1.1,
274   "directNetProfit": 1.1,
275   "directNetProfitMargin": 1.1,
276   "totalDirectFees": 1.1,
277   "displayHourlyPayRate": "displayHourlyPayRate",
278   "displayEmplCostValue": "displayEmplCostValue",
279   "displayEmplCostPct": "displayEmplCostPct",
280   "displayEmplCostPctAmount": "displayEmplCostPctAmount",
281   "displayEmplTotalCost": "displayEmplTotalCost",
282   "displayClientFee": "displayClientFee",
283   "displayClientDiscount": "displayClientDiscount",
284   "displayClientDiscountAmount": "displayClientDiscountAmount",
285   "displayHourlyBillRate": "displayHourlyBillRate",
286   "displayRealizedBillRate": "displayRealizedBillRate",
287   "displayNetSpread": "displayNetSpread",
288   "displayNetProfitMargin": "displayNetProfitMargin",
289   "displayBillRate": "displayBillRate",
290   "displayBonusFlat": "displayBonusFlat",
291   "displayBonusPct": "displayBonusPct",
292   "displayCommissionAmount": "displayCommissionAmount",
293   "displayCommissionFee": "displayCommissionFee",
294   "displayCommissionPct": "displayCommissionPct",
295   "displayCommissionPctAmount": "displayCommissionPctAmount",
296   "displayDirectFeeAmount": "displayDirectFeeAmount",
297   "displayDirectFeeFlat": "displayDirectFeeFlat",
298   "displayDirectFeePct": "displayDirectFeePct",
299   "displayDirectNetProfit": "displayDirectNetProfit",
300   "displayDirectNetProfitMargin": "displayDirectNetProfitMargin",
301   "displayMboFlat": "displayMboFlat",
302   "displayMboPct": "displayMboPct",
303   "displayPayRate": "displayPayRate",
304   "displayTotalDirectFees": "displayTotalDirectFees",
305   "displayCommissionEndDate": "displayCommissionEndDate",
306   "displayHireDate": "displayHireDate",
307   "displayStartDate": "displayStartDate",
308   "displayEndDate": "displayEndDate"
309 }

Persist Placement

Up Next

Built with

1	{
2	"applicants": [
3	{
4	"userGk": 1000000,
5	"guid": "guid",
6	"salutation": {
7	"id": 1000000
8	},
9	"firstName": "firstName",
10	"middleName": "middleName",
11	"lastName": "lastName",
12	"nickname": "nickname",
13	"email": "email",
14	"workEmail": "workEmail",
15	"companyGk": 1000000,
16	"companyName": "companyName",
17	"companyGuid": "companyGuid",
18	"createUserGk": 1000000,
19	"modifyUserGk": 1000000,
20	"username": "username",
21	"avatarUrl": "avatarUrl",
22	"timezoneId": 1,
23	"localeId": 1,
24	"statusId": 1,
25	"phones": [
26	{}
27	],
28	"primary": true,
29	"createDate": "2024-01-15T09:30:00Z",
30	"modifyDate": "2024-01-15T09:30:00Z",
31	"themeGk": 1000000,
32	"lookDate": "2024-01-15T09:30:00Z",
33	"unsubscribeDate": "2024-01-15T09:30:00Z",
34	"delegates": [
35	{}
36	],
37	"emailSignature": "emailSignature",
38	"address": "address",
39	"address2": "address2",
40	"city": "city",
41	"state": {
42	"id": 1000000
43	},
44	"postalCode": "postalCode",
45	"status": {
46	"id": 1000000
47	},
48	"employmentType": {
49	"id": 1000000
50	},
51	"emailAllowed": true,
52	"smsAllowed": true,
53	"doNotHire": true,
54	"preferredLocation": "preferredLocation",
55	"availableDate": "2024-01-15T09:30:00Z",
56	"availabilityComments": "availabilityComments",
57	"referredBy": "referredBy",
58	"currentCompany": "currentCompany",
59	"currentTitle": "currentTitle",
60	"currentPay": 1.1,
61	"currentPayType": {
62	"id": 1000000
63	},
64	"desiredPay": 1.1,
65	"desiredPayType": {
66	"id": 1000000
67	},
68	"payComments": "payComments",
69	"taxId": 1,
70	"dob": "2024-01-15T09:30:00Z",
71	"disabilityStatus": {
72	"id": 1000000
73	},
74	"currentEmployee": true,
75	"sourceOther": "sourceOther",
76	"rank": 1,
77	"primarySkills": "primarySkills",
78	"gender": {
79	"id": 1000000
80	},
81	"raceEthnicity": {
82	"id": 1000000
83	},
84	"veteranStatus": {
85	"id": 1000000
86	},
87	"workPermit": {
88	"id": 1000000
89	},
90	"newResume": true,
91	"confidential": true,
92	"resumes": [
93	{
94	"name": "name",
95	"content": "content"
96	}
97	],
98	"udfSections": [
99	{}
100	],
101	"employmentHistory": [
102	{}
103	],
104	"education": [
105	{}
106	],
107	"employer": "employer",
108	"applStatName": "applStatName",
109	"title": "title",
110	"statusNote": "statusNote",
111	"socialLinks": [
112	{}
113	],
114	"ownedByMasterCompany": true,
115	"linkClientContactGk": 1000000,
116	"tags": [
117	{}
118	],
119	"personalData": {
120	"id": 1000000
121	},
122	"sensitiveData": {
123	"id": 1000000
124	},
125	"duplicate": true,
126	"attachments": [
127	{
128	"filedata": [
129	"PEJhc2U2NCBFbmNvZGVkIEZpbGUgRGF0YT4="
130	],
131	"filename": "Ponce_DeLeon_Resume.pdf",
132	"guid": "UUUUUUUU-VVVV-XXXX-YYYY-ZZZZZZZZZZZZ",
133	"compressed": true,
134	"attachGk": 123456,
135	"createDate": "2018-08-23T11:20:29Z",
136	"createUserGk": 123456,
137	"createUser": "Aldonza Alfonso",
138	"description": "Resume in word format, sent by applicant.",
139	"filetype": "aplication/pdf",
140	"filesize": 65536,
141	"publicView": true,
142	"clientContract": true,
143	"basicQualification": true,
144	"interview": true,
145	"attached": true,
146	"displayCreateDate": "08/23/2018 11:20:29 AM"
147	}
148	],
149	"override": true,
150	"visitorId": "visitorId",
151	"ssn": "ssn",
152	"name": "name",
153	"displayFullName": "displayFullName",
154	"displayNameLastFirst": "displayNameLastFirst",
155	"bestEmail": "bestEmail",
156	"displayName": "displayName"
157	}
158	],
159	"reqGk": 1000000,
160	"guid": "guid",
161	"reqGuid": "reqGuid",
162	"jobTitle": "jobTitle",
163	"applicantGk": 1000000,
164	"applicantGuid": "applicantGuid",
165	"applicant": "applicant",
166	"placementType": {
167	"id": 1000000,
168	"name": "name"
169	},
170	"recruiterGk": 1000000,
171	"recruiterGuid": "recruiterGuid",
172	"recruiter": "recruiter",
173	"clientContactGk": 1000000,
174	"clientContactGuid": "clientContactGuid",
175	"clientContact": "clientContact",
176	"clientGk": 1000000,
177	"clientGuid": "clientGuid",
178	"clientName": "clientName",
179	"officeGk": 1000000,
180	"officeGuid": "officeGuid",
181	"officeName": "officeName",
182	"startDate": "2024-01-15T09:30:00Z",
183	"endDate": "2024-01-15T09:30:00Z",
184	"hireDate": "2024-01-15T09:30:00Z",
185	"commissionEndDate": "2024-01-15T09:30:00Z",
186	"commissionFee": 1.1,
187	"commissionPct": 1.1,
188	"guarantee": "guarantee",
189	"billRate": 1.1,
190	"billType": {
191	"id": 1000000,
192	"name": "name"
193	},
194	"payRate": 1.1,
195	"payType": {
196	"id": 1000000,
197	"name": "name"
198	},
199	"conversionFee": 1.1,
200	"directFeePct": 1.1,
201	"directFeeFlat": 1.1,
202	"bonusPct": 1.1,
203	"bonusFlat": 1.1,
204	"bonusNotes": "bonusNotes",
205	"mboPct": 1.1,
206	"mboFlat": 1.1,
207	"mboNotes": "mboNotes",
208	"employmentType": {
209	"id": 1000000,
210	"name": "name",
211	"costValue": 1.1,
212	"costPercentage": 1.1,
213	"sortOrder": 1,
214	"rate": 1.1
215	},
216	"emplCostValue": 1.1,
217	"emplCostPercentage": 1.1,
218	"clientFee": 1.1,
219	"clientDiscount": 1.1,
220	"currentPlacement": true,
221	"createUser": "createUser",
222	"createUserGk": 1000000,
223	"createDate": "2024-01-15T09:30:00Z",
224	"modifyUser": "modifyUser",
225	"modifyUserGk": 1000000,
226	"modifyDate": "2024-01-15T09:30:00Z",
227	"newPlacement": true,
228	"updateProductPayPlan": true,
229	"placementProduct": {
230	"payPlan": {
231	"productPayPlanGk": 1000000,
232	"guid": "guid",
233	"name": "name",
234	"description": "description",
235	"retainerModifier": 1.1,
236	"sortOrder": 1,
237	"createDate": "2024-01-15T09:30:00Z",
238	"modifyDate": "2024-01-15T09:30:00Z",
239	"clientOfficeGk": 1000000,
240	"clientGk": 1000000,
241	"childCompanyGk": 1000000,
242	"productPayPlanLines": [
243	{}
244	],
245	"assigned": true,
246	"invoiced": true
247	}
248	},
249	"udfSections": [
250	{
251	"sectionGk": 1000000,
252	"sectionName": "sectionName",
253	"sortOrder": 1,
254	"fields": [
255	{}
256	],
257	"fieldGk": 1000000,
258	"entityTypes": [
259	"1"
260	]
261	}
262	],
263	"emplCostPctAmount": 1.1,
264	"hourlyPayRate": 1.1,
265	"emplTotalCost": 1.1,
266	"hourlyBillRate": 1.1,
267	"clientDiscountAmount": 1.1,
268	"realizedBillRate": 1.1,
269	"netSpread": 1.1,
270	"netProfitMargin": 1.1,
271	"commissionAmount": 1.1,
272	"commissionPctAmount": 1.1,
273	"directFeeAmount": 1.1,
274	"directNetProfit": 1.1,
275	"directNetProfitMargin": 1.1,
276	"totalDirectFees": 1.1,
277	"displayHourlyPayRate": "displayHourlyPayRate",
278	"displayEmplCostValue": "displayEmplCostValue",
279	"displayEmplCostPct": "displayEmplCostPct",
280	"displayEmplCostPctAmount": "displayEmplCostPctAmount",
281	"displayEmplTotalCost": "displayEmplTotalCost",
282	"displayClientFee": "displayClientFee",
283	"displayClientDiscount": "displayClientDiscount",
284	"displayClientDiscountAmount": "displayClientDiscountAmount",
285	"displayHourlyBillRate": "displayHourlyBillRate",
286	"displayRealizedBillRate": "displayRealizedBillRate",
287	"displayNetSpread": "displayNetSpread",
288	"displayNetProfitMargin": "displayNetProfitMargin",
289	"displayBillRate": "displayBillRate",
290	"displayBonusFlat": "displayBonusFlat",
291	"displayBonusPct": "displayBonusPct",
292	"displayCommissionAmount": "displayCommissionAmount",
293	"displayCommissionFee": "displayCommissionFee",
294	"displayCommissionPct": "displayCommissionPct",
295	"displayCommissionPctAmount": "displayCommissionPctAmount",
296	"displayDirectFeeAmount": "displayDirectFeeAmount",
297	"displayDirectFeeFlat": "displayDirectFeeFlat",
298	"displayDirectFeePct": "displayDirectFeePct",
299	"displayDirectNetProfit": "displayDirectNetProfit",
300	"displayDirectNetProfitMargin": "displayDirectNetProfitMargin",
301	"displayMboFlat": "displayMboFlat",
302	"displayMboPct": "displayMboPct",
303	"displayPayRate": "displayPayRate",
304	"displayTotalDirectFees": "displayTotalDirectFees",
305	"displayCommissionEndDate": "displayCommissionEndDate",
306	"displayHireDate": "displayHireDate",
307	"displayStartDate": "displayStartDate",
308	"displayEndDate": "displayEndDate"
309	}