Get Company

GET

Lookup a company by ID

Path parameters

companyGklongRequired

Headers

X-Brightmove-User-ApiKeystringRequired

Response

companyGklongOptional

legacyIdstringOptional

guidstringOptional

namestringOptional

addressstringOptional

address2stringOptional

citystringOptional

stateIDintegerOptional

stateNamestringOptional

postalCodestringOptional

countryCodestringOptional

countryNamestringOptional

emailstringOptional

inboundEmailstringOptional

emailParserDomainstringOptional

legacyInboundEmailstringOptional

allowAnyInboundEmailbooleanOptional

templatebooleanOptional

supportEmailstringOptional

supportPhonestringOptional

descriptionstringOptional

websitestringOptional

createDatedatetimeOptional

modifyDatedatetimeOptional

licensedUsersintegerOptional

createUserobjectOptional

modifyUserobjectOptional

openGraphImagestringOptional

directEmployerbooleanOptional

backOfficeTermobjectOptional

customerobjectOptional

accountNamestringOptional

countryListlist of objectsOptional

GET

1 curl https://app.brightmove.com/ATS/app/company/get/1000000

200Retrieved

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

List Office Employees

Up Next

Built with

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