List Offices by Client

GET

Returns a List of Office beans from a Client ID

Path parameters

guidstringRequired

Headers

X-Brightmove-User-ApiKeystringRequired

Response

officeGklongOptional

guidstringOptional

namestringOptional

locationobjectOptional

addressstringOptional

address2stringOptional

citystringOptional

stateobjectOptional

postalCodestringOptional

phoneslist of objectsOptional

clientobjectOptional

The Client object to save.

createDatedatetimeOptional

modifyDatedatetimeOptional

createUserobjectOptional

modifyUserobjectOptional

primarySalesUserobjectOptional

primarybooleanOptional

statusIdintegerOptional

customerobjectOptional

accountNamestringOptional

backOfficeTermobjectOptional

additionSalesUserslist of objectsOptional

udfSectionslist of objectsOptional

GET

1 curl https://app.brightmove.com/ATS/app/office/client/guid

200Retrieved

1 [
2   {
3     "officeGk": 1000000,
4     "guid": "guid",
5     "name": "name",
6     "location": {
7       "address1": "address1",
8       "address2": "address2",
9       "city": "city",
10       "state": {
11         "id": 1000000
12       },
13       "postalCode": "postalCode",
14       "country": {
15         "id": 1000000
16       }
17     },
18     "address": "address",
19     "address2": "address2",
20     "city": "city",
21     "state": {
22       "id": 1000000,
23       "name": "name",
24       "country": {
25         "id": 1000000
26       },
27       "abbr": "abbr"
28     },
29     "postalCode": "postalCode",
30     "phones": [
31       {}
32     ],
33     "client": {
34       "guid": "guid",
35       "statusId": 1,
36       "clientGk": 1000000,
37       "companyName": "companyName",
38       "website": "website",
39       "billAddress1": "billAddress1",
40       "billAddress2": "billAddress2",
41       "billCity": "billCity",
42       "billState": {
43         "id": 1000000
44       },
45       "billCountry": "billCountry",
46       "billPostalCode": "billPostalCode",
47       "discountPercentage": 1.1,
48       "discountFee": 1.1,
49       "companyGk": 1000000,
50       "stockSymbol": "stockSymbol",
51       "companyInfo": "companyInfo",
52       "workgroup": {
53         "id": 1000000
54       },
55       "createDate": "2024-01-15T09:30:00Z",
56       "modifyDate": "2024-01-15T09:30:00Z",
57       "legacyId": "legacyId",
58       "overrideEeoc": true,
59       "overrideVeteranStatus": true,
60       "overrideDisabledStatus": true,
61       "overrideJobBoardCompany": true,
62       "createMain": true,
63       "accountName": "accountName",
64       "additionSalesUsers": [
65         {}
66       ],
67       "showOverrideEEOC": true,
68       "udfSections": [
69         {}
70       ],
71       "showUdfSections": true,
72       "mainPhones": [
73         {}
74       ],
75       "tags": [
76         {}
77       ]
78     },
79     "createDate": "2024-01-15T09:30:00Z",
80     "modifyDate": "2024-01-15T09:30:00Z",
81     "createUser": {
82       "userGk": 1000000,
83       "guid": "guid",
84       "salutation": {
85         "id": 1000000
86       },
87       "firstName": "firstName",
88       "middleName": "middleName",
89       "lastName": "lastName",
90       "nickname": "nickname",
91       "email": "email",
92       "workEmail": "workEmail",
93       "companyGk": 1000000,
94       "companyName": "companyName",
95       "companyGuid": "companyGuid",
96       "createUserGk": 1000000,
97       "modifyUserGk": 1000000,
98       "username": "username",
99       "avatarUrl": "avatarUrl",
100       "timezoneId": 1,
101       "localeId": 1,
102       "statusId": 1,
103       "phones": [
104         {}
105       ],
106       "primary": true,
107       "createDate": "2024-01-15T09:30:00Z",
108       "modifyDate": "2024-01-15T09:30:00Z",
109       "themeGk": 1000000,
110       "lookDate": "2024-01-15T09:30:00Z",
111       "unsubscribeDate": "2024-01-15T09:30:00Z",
112       "delegates": [
113         {}
114       ],
115       "emailSignature": "emailSignature",
116       "name": "name",
117       "displayName": "displayName",
118       "displayNameLastFirst": "displayNameLastFirst",
119       "bestEmail": "bestEmail",
120       "displayFullName": "displayFullName"
121     },
122     "modifyUser": {
123       "userGk": 1000000,
124       "guid": "guid",
125       "salutation": {
126         "id": 1000000
127       },
128       "firstName": "firstName",
129       "middleName": "middleName",
130       "lastName": "lastName",
131       "nickname": "nickname",
132       "email": "email",
133       "workEmail": "workEmail",
134       "companyGk": 1000000,
135       "companyName": "companyName",
136       "companyGuid": "companyGuid",
137       "createUserGk": 1000000,
138       "modifyUserGk": 1000000,
139       "username": "username",
140       "avatarUrl": "avatarUrl",
141       "timezoneId": 1,
142       "localeId": 1,
143       "statusId": 1,
144       "phones": [
145         {}
146       ],
147       "primary": true,
148       "createDate": "2024-01-15T09:30:00Z",
149       "modifyDate": "2024-01-15T09:30:00Z",
150       "themeGk": 1000000,
151       "lookDate": "2024-01-15T09:30:00Z",
152       "unsubscribeDate": "2024-01-15T09:30:00Z",
153       "delegates": [
154         {}
155       ],
156       "emailSignature": "emailSignature",
157       "name": "name",
158       "displayName": "displayName",
159       "displayNameLastFirst": "displayNameLastFirst",
160       "bestEmail": "bestEmail",
161       "displayFullName": "displayFullName"
162     },
163     "primarySalesUser": {
164       "userGk": 1000000,
165       "guid": "guid",
166       "salutation": {
167         "id": 1000000
168       },
169       "firstName": "firstName",
170       "middleName": "middleName",
171       "lastName": "lastName",
172       "nickname": "nickname",
173       "email": "email",
174       "workEmail": "workEmail",
175       "companyGk": 1000000,
176       "companyName": "companyName",
177       "companyGuid": "companyGuid",
178       "createUserGk": 1000000,
179       "modifyUserGk": 1000000,
180       "username": "username",
181       "avatarUrl": "avatarUrl",
182       "timezoneId": 1,
183       "localeId": 1,
184       "statusId": 1,
185       "phones": [
186         {}
187       ],
188       "primary": true,
189       "createDate": "2024-01-15T09:30:00Z",
190       "modifyDate": "2024-01-15T09:30:00Z",
191       "themeGk": 1000000,
192       "lookDate": "2024-01-15T09:30:00Z",
193       "unsubscribeDate": "2024-01-15T09:30:00Z",
194       "delegates": [
195         {}
196       ],
197       "emailSignature": "emailSignature",
198       "name": "name",
199       "displayName": "displayName",
200       "displayNameLastFirst": "displayNameLastFirst",
201       "bestEmail": "bestEmail",
202       "displayFullName": "displayFullName"
203     },
204     "primary": true,
205     "statusId": 1,
206     "customer": {
207       "name": "name",
208       "description": "description",
209       "refNum": "refNum",
210       "updated": true,
211       "remove": true
212     },
213     "accountName": "accountName",
214     "backOfficeTerm": {
215       "termGk": 1000000,
216       "name": "name",
217       "dueDays": 1,
218       "refNum": "refNum"
219     },
220     "additionSalesUsers": [
221       {}
222     ],
223     "udfSections": [
224       {}
225     ]
226   }
227 ]

Save an Office

Up Next

Built with

1	[
2	{
3	"officeGk": 1000000,
4	"guid": "guid",
5	"name": "name",
6	"location": {
7	"address1": "address1",
8	"address2": "address2",
9	"city": "city",
10	"state": {
11	"id": 1000000
12	},
13	"postalCode": "postalCode",
14	"country": {
15	"id": 1000000
16	}
17	},
18	"address": "address",
19	"address2": "address2",
20	"city": "city",
21	"state": {
22	"id": 1000000,
23	"name": "name",
24	"country": {
25	"id": 1000000
26	},
27	"abbr": "abbr"
28	},
29	"postalCode": "postalCode",
30	"phones": [
31	{}
32	],
33	"client": {
34	"guid": "guid",
35	"statusId": 1,
36	"clientGk": 1000000,
37	"companyName": "companyName",
38	"website": "website",
39	"billAddress1": "billAddress1",
40	"billAddress2": "billAddress2",
41	"billCity": "billCity",
42	"billState": {
43	"id": 1000000
44	},
45	"billCountry": "billCountry",
46	"billPostalCode": "billPostalCode",
47	"discountPercentage": 1.1,
48	"discountFee": 1.1,
49	"companyGk": 1000000,
50	"stockSymbol": "stockSymbol",
51	"companyInfo": "companyInfo",
52	"workgroup": {
53	"id": 1000000
54	},
55	"createDate": "2024-01-15T09:30:00Z",
56	"modifyDate": "2024-01-15T09:30:00Z",
57	"legacyId": "legacyId",
58	"overrideEeoc": true,
59	"overrideVeteranStatus": true,
60	"overrideDisabledStatus": true,
61	"overrideJobBoardCompany": true,
62	"createMain": true,
63	"accountName": "accountName",
64	"additionSalesUsers": [
65	{}
66	],
67	"showOverrideEEOC": true,
68	"udfSections": [
69	{}
70	],
71	"showUdfSections": true,
72	"mainPhones": [
73	{}
74	],
75	"tags": [
76	{}
77	]
78	},
79	"createDate": "2024-01-15T09:30:00Z",
80	"modifyDate": "2024-01-15T09:30:00Z",
81	"createUser": {
82	"userGk": 1000000,
83	"guid": "guid",
84	"salutation": {
85	"id": 1000000
86	},
87	"firstName": "firstName",
88	"middleName": "middleName",
89	"lastName": "lastName",
90	"nickname": "nickname",
91	"email": "email",
92	"workEmail": "workEmail",
93	"companyGk": 1000000,
94	"companyName": "companyName",
95	"companyGuid": "companyGuid",
96	"createUserGk": 1000000,
97	"modifyUserGk": 1000000,
98	"username": "username",
99	"avatarUrl": "avatarUrl",
100	"timezoneId": 1,
101	"localeId": 1,
102	"statusId": 1,
103	"phones": [
104	{}
105	],
106	"primary": true,
107	"createDate": "2024-01-15T09:30:00Z",
108	"modifyDate": "2024-01-15T09:30:00Z",
109	"themeGk": 1000000,
110	"lookDate": "2024-01-15T09:30:00Z",
111	"unsubscribeDate": "2024-01-15T09:30:00Z",
112	"delegates": [
113	{}
114	],
115	"emailSignature": "emailSignature",
116	"name": "name",
117	"displayName": "displayName",
118	"displayNameLastFirst": "displayNameLastFirst",
119	"bestEmail": "bestEmail",
120	"displayFullName": "displayFullName"
121	},
122	"modifyUser": {
123	"userGk": 1000000,
124	"guid": "guid",
125	"salutation": {
126	"id": 1000000
127	},
128	"firstName": "firstName",
129	"middleName": "middleName",
130	"lastName": "lastName",
131	"nickname": "nickname",
132	"email": "email",
133	"workEmail": "workEmail",
134	"companyGk": 1000000,
135	"companyName": "companyName",
136	"companyGuid": "companyGuid",
137	"createUserGk": 1000000,
138	"modifyUserGk": 1000000,
139	"username": "username",
140	"avatarUrl": "avatarUrl",
141	"timezoneId": 1,
142	"localeId": 1,
143	"statusId": 1,
144	"phones": [
145	{}
146	],
147	"primary": true,
148	"createDate": "2024-01-15T09:30:00Z",
149	"modifyDate": "2024-01-15T09:30:00Z",
150	"themeGk": 1000000,
151	"lookDate": "2024-01-15T09:30:00Z",
152	"unsubscribeDate": "2024-01-15T09:30:00Z",
153	"delegates": [
154	{}
155	],
156	"emailSignature": "emailSignature",
157	"name": "name",
158	"displayName": "displayName",
159	"displayNameLastFirst": "displayNameLastFirst",
160	"bestEmail": "bestEmail",
161	"displayFullName": "displayFullName"
162	},
163	"primarySalesUser": {
164	"userGk": 1000000,
165	"guid": "guid",
166	"salutation": {
167	"id": 1000000
168	},
169	"firstName": "firstName",
170	"middleName": "middleName",
171	"lastName": "lastName",
172	"nickname": "nickname",
173	"email": "email",
174	"workEmail": "workEmail",
175	"companyGk": 1000000,
176	"companyName": "companyName",
177	"companyGuid": "companyGuid",
178	"createUserGk": 1000000,
179	"modifyUserGk": 1000000,
180	"username": "username",
181	"avatarUrl": "avatarUrl",
182	"timezoneId": 1,
183	"localeId": 1,
184	"statusId": 1,
185	"phones": [
186	{}
187	],
188	"primary": true,
189	"createDate": "2024-01-15T09:30:00Z",
190	"modifyDate": "2024-01-15T09:30:00Z",
191	"themeGk": 1000000,
192	"lookDate": "2024-01-15T09:30:00Z",
193	"unsubscribeDate": "2024-01-15T09:30:00Z",
194	"delegates": [
195	{}
196	],
197	"emailSignature": "emailSignature",
198	"name": "name",
199	"displayName": "displayName",
200	"displayNameLastFirst": "displayNameLastFirst",
201	"bestEmail": "bestEmail",
202	"displayFullName": "displayFullName"
203	},
204	"primary": true,
205	"statusId": 1,
206	"customer": {
207	"name": "name",
208	"description": "description",
209	"refNum": "refNum",
210	"updated": true,
211	"remove": true
212	},
213	"accountName": "accountName",
214	"backOfficeTerm": {
215	"termGk": 1000000,
216	"name": "name",
217	"dueDays": 1,
218	"refNum": "refNum"
219	},
220	"additionSalesUsers": [
221	{}
222	],
223	"udfSections": [
224	{}
225	]
226	}
227	]