Get Company Office

GET

Find a Company Office by GUID

Path parameters

guidstringRequired

Headers

X-Brightmove-User-ApiKeystringRequired

Response

officeGklongOptional

guidstringOptional

namestringOptional

locationobjectOptional

addressstringOptional

address2stringOptional

citystringOptional

stateobjectOptional

postalCodestringOptional

phoneslist of objectsOptional

createDatedatetimeOptional

modifyDatedatetimeOptional

costCenterstringOptional

createUserobjectOptional

modifyUserobjectOptional

emailstringOptional

countrystringOptional

GET

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

200Retrieved

1 {
2   "officeGk": 1000000,
3   "guid": "guid",
4   "name": "name",
5   "location": {
6     "address1": "address1",
7     "address2": "address2",
8     "city": "city",
9     "state": {
10       "id": 1000000,
11       "name": "name",
12       "country": {
13         "id": 1000000
14       },
15       "abbr": "abbr"
16     },
17     "postalCode": "postalCode",
18     "country": {
19       "id": 1000000,
20       "name": "name",
21       "countryCode": "countryCode"
22     }
23   },
24   "address": "address",
25   "address2": "address2",
26   "city": "city",
27   "state": {
28     "id": 1000000,
29     "name": "name",
30     "country": {
31       "id": 1000000,
32       "name": "name",
33       "countryCode": "countryCode"
34     },
35     "abbr": "abbr"
36   },
37   "postalCode": "postalCode",
38   "phones": [
39     {
40       "id": 1000000,
41       "type": {
42         "id": 1000000
43       },
44       "phoneNumber": "phoneNumber",
45       "entityGk": 1000000
46     }
47   ],
48   "createDate": "2024-01-15T09:30:00Z",
49   "modifyDate": "2024-01-15T09:30:00Z",
50   "costCenter": "costCenter",
51   "createUser": {
52     "userGk": 1000000,
53     "guid": "guid",
54     "salutation": {
55       "id": 1000000,
56       "name": "name"
57     },
58     "firstName": "firstName",
59     "middleName": "middleName",
60     "lastName": "lastName",
61     "nickname": "nickname",
62     "email": "email",
63     "workEmail": "workEmail",
64     "type": {
65       "id": 1,
66       "name": "name"
67     },
68     "companyGk": 1000000,
69     "companyName": "companyName",
70     "companyGuid": "companyGuid",
71     "createUserGk": 1000000,
72     "modifyUserGk": 1000000,
73     "username": "username",
74     "avatarUrl": "avatarUrl",
75     "timezoneId": 1,
76     "localeId": 1,
77     "statusId": 1,
78     "displayFullName": "displayFullName",
79     "displayNameLastFirst": "displayNameLastFirst",
80     "bestEmail": "bestEmail",
81     "displayName": "displayName"
82   },
83   "modifyUser": {
84     "userGk": 1000000,
85     "guid": "guid",
86     "salutation": {
87       "id": 1000000,
88       "name": "name"
89     },
90     "firstName": "firstName",
91     "middleName": "middleName",
92     "lastName": "lastName",
93     "nickname": "nickname",
94     "email": "email",
95     "workEmail": "workEmail",
96     "type": {
97       "id": 1,
98       "name": "name"
99     },
100     "companyGk": 1000000,
101     "companyName": "companyName",
102     "companyGuid": "companyGuid",
103     "createUserGk": 1000000,
104     "modifyUserGk": 1000000,
105     "username": "username",
106     "avatarUrl": "avatarUrl",
107     "timezoneId": 1,
108     "localeId": 1,
109     "statusId": 1,
110     "displayFullName": "displayFullName",
111     "displayNameLastFirst": "displayNameLastFirst",
112     "bestEmail": "bestEmail",
113     "displayName": "displayName"
114   },
115   "email": "email",
116   "country": "country"
117 }

Save Company Office

Up Next

Built with

1	{
2	"officeGk": 1000000,
3	"guid": "guid",
4	"name": "name",
5	"location": {
6	"address1": "address1",
7	"address2": "address2",
8	"city": "city",
9	"state": {
10	"id": 1000000,
11	"name": "name",
12	"country": {
13	"id": 1000000
14	},
15	"abbr": "abbr"
16	},
17	"postalCode": "postalCode",
18	"country": {
19	"id": 1000000,
20	"name": "name",
21	"countryCode": "countryCode"
22	}
23	},
24	"address": "address",
25	"address2": "address2",
26	"city": "city",
27	"state": {
28	"id": 1000000,
29	"name": "name",
30	"country": {
31	"id": 1000000,
32	"name": "name",
33	"countryCode": "countryCode"
34	},
35	"abbr": "abbr"
36	},
37	"postalCode": "postalCode",
38	"phones": [
39	{
40	"id": 1000000,
41	"type": {
42	"id": 1000000
43	},
44	"phoneNumber": "phoneNumber",
45	"entityGk": 1000000
46	}
47	],
48	"createDate": "2024-01-15T09:30:00Z",
49	"modifyDate": "2024-01-15T09:30:00Z",
50	"costCenter": "costCenter",
51	"createUser": {
52	"userGk": 1000000,
53	"guid": "guid",
54	"salutation": {
55	"id": 1000000,
56	"name": "name"
57	},
58	"firstName": "firstName",
59	"middleName": "middleName",
60	"lastName": "lastName",
61	"nickname": "nickname",
62	"email": "email",
63	"workEmail": "workEmail",
64	"type": {
65	"id": 1,
66	"name": "name"
67	},
68	"companyGk": 1000000,
69	"companyName": "companyName",
70	"companyGuid": "companyGuid",
71	"createUserGk": 1000000,
72	"modifyUserGk": 1000000,
73	"username": "username",
74	"avatarUrl": "avatarUrl",
75	"timezoneId": 1,
76	"localeId": 1,
77	"statusId": 1,
78	"displayFullName": "displayFullName",
79	"displayNameLastFirst": "displayNameLastFirst",
80	"bestEmail": "bestEmail",
81	"displayName": "displayName"
82	},
83	"modifyUser": {
84	"userGk": 1000000,
85	"guid": "guid",
86	"salutation": {
87	"id": 1000000,
88	"name": "name"
89	},
90	"firstName": "firstName",
91	"middleName": "middleName",
92	"lastName": "lastName",
93	"nickname": "nickname",
94	"email": "email",
95	"workEmail": "workEmail",
96	"type": {
97	"id": 1,
98	"name": "name"
99	},
100	"companyGk": 1000000,
101	"companyName": "companyName",
102	"companyGuid": "companyGuid",
103	"createUserGk": 1000000,
104	"modifyUserGk": 1000000,
105	"username": "username",
106	"avatarUrl": "avatarUrl",
107	"timezoneId": 1,
108	"localeId": 1,
109	"statusId": 1,
110	"displayFullName": "displayFullName",
111	"displayNameLastFirst": "displayNameLastFirst",
112	"bestEmail": "bestEmail",
113	"displayName": "displayName"
114	},
115	"email": "email",
116	"country": "country"
117	}