Get Contact by Company Id
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| company_id | string |
Required |
Body Parameters :
None.
Response Information
Resource Description :
contact| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary key |
globally unique identifier |
Required |
| firstname |
Firstname of the contact |
string |
Max length: 50 |
| lastname |
Lastname of the contact. If you have one single field available for firstname+lastname then use Lastname |
string |
Required Max length: 50 |
| company_id |
Company of the contact |
globally unique identifier |
Optionally required : company_id,company_code or company must be provided |
| company_code |
Embedded entity "company" using ERP PK when adding/updating contact |
string |
Optionally required : company_id,company_code or company must be provided |
| company |
Embedded entity "company" when adding/updating contact |
company |
Optionally required : company_id,company_code or company must be provided |
| db_language_id |
Language of the contact.If empty, will use the default on the system |
globally unique identifier | |
| db_language_code |
Language code entity using international isocode when adding/updating contact |
string | |
| db_title_id |
The title of the contact |
globally unique identifier | |
| archived |
Archive this contact to not have it anymore on the search |
boolean | |
| functions |
Function of the contact (ServiceManager,...) |
string |
Max length: 64 |
| e_login |
Login of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| e_password |
Password in clear text of the contact (if have access to ServiceDesk) |
string |
Max length: 50 |
| notes |
Notes/Remark field |
string | |
| birthdate |
Birthday date |
date | |
| create_date |
Creation date+time |
date | |
| phone |
Phone number of the contact |
string |
Max length: 50 |
| mobile |
a number of the contact |
string |
Max length: 50 |
|
|
string |
Max length: 250 |
|
| skype |
skype |
string |
Max length: 250 |
| private_phone |
Private phone number of the contact |
string |
Max length: 50 |
| private_mobile |
Private mobile number of the contact |
string |
Max length: 50 |
| private_email |
Private email |
string |
Max length: 250 |
| reference_back_office |
Field used for Embedded entity (store there your ERP PK) |
string |
Max length: 50 |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "ee2a0280-f2da-438b-a603-350e04124f0d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b53db5ac-0309-48ee-ab7b-901b49e033f8",
"company_code": "sample string 5",
"company": {
"id": "3d605b54-2e5c-44ca-8143-d32db3869932",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-05T12:29:00.9305872+00:00",
"sales_territory_id": "43e4ff63-d966-45ce-90c0-c82c7cf74ace",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5dbb2e1b-5c5a-4c40-88b4-a8946c8a03a5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "32f54549-c967-47dd-89f7-855b72dd0076",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eef8936d-d02b-43c8-b7eb-69395d929f3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c6f03e9b-37b5-4b95-b50d-86805ffbbe29",
"db_currency_id": "f1c85e44-f1c5-4900-bdab-ba5ef65694b5",
"db_language_id": "4e64f774-a15f-4e66-947c-585201af23b9",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-09-05T12:29:00.9305872+00:00"
},
"modified_dateutc": "2025-09-05T12:29:00.9305872+00:00"
},
"marketing_segment_id": "c3e7aae9-457e-4f64-93c2-23be79d91536",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2bae9604-d65e-4df0-a705-104dccd35b28",
"sales_organization_code": "sample string 13",
"company_sales_status_code": "sample string 14",
"vat_reg_code": "sample string 15",
"is_working_address": true,
"parent_id": "aef48cd0-95ec-483c-97a1-1a1e0e22a388",
"parent_company_code": "sample string 18",
"phone": "sample string 19",
"fax": "sample string 20",
"url": "sample string 21",
"email": "sample string 22",
"street": "sample string 23",
"street_number": "sample string 24",
"city": "sample string 25",
"zip": "sample string 26",
"db_country_id": "6943c4e0-98dc-476f-bb58-60586849bc7c",
"db_country_code": "sample string 28",
"feelist_id": "54ca0611-3643-4c97-9558-64bb360c23ad",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9049f69e-cd09-49c7-8cef-827478d5d37a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8a6fe73f-f848-4b14-af77-1124cb8e0077",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-05T12:29:00.9305872+00:00",
"db_currency_id": "1d737e8d-b04b-4d92-a434-39d476cf02e4",
"db_currency_code": "sample string 10"
},
"company_type_id": "5473b3cd-f37d-4064-99b2-b40ef98a310f",
"company_type_name": "sample string 32",
"company_type": {
"id": "99d2a26b-9b85-4a08-b20c-0ce3d185b3f5",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c9f56083-d337-4ef2-9f4b-7d06f4958e4a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d492f66d-b360-4ca3-82af-3e983ca72d79",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "32adc50b-b9c7-4fc1-b3a0-67ed88cb4faa",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fc6314d3-898f-4fa3-b0b0-6fc7d1932aec",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f3f71fef-8dd7-4f99-bc20-881d520e55ec",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-05T12:29:00.9305872+00:00"
},
"company_sector_id": "7db5e79a-0ba5-4436-b8ab-047e43d271d9",
"company_sector_code": "sample string 41",
"is_lead": true,
"is_subcontractor": true,
"latitude": 1.0,
"longitude": 1.0,
"street2": "sample string 44",
"bic_code": "sample string 45",
"specialities": "sample string 46",
"register_number": "sample string 47",
"register_city": "sample string 48",
"bankaccount": "sample string 49",
"mobile": "sample string 50",
"service_manager_user_id": "7b8a35a7-2801-49c7-af41-5c1a3a79aeb0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c1343055-ea41-4494-b04a-fd3ddfa02417",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0d232f73-3290-42e7-8ba5-2757b82914e9",
"account_manager_user_code": "sample string 56",
"company_status_id": "ae4a9f4a-c95b-46eb-a6c1-93253ac9e32f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-05T12:29:00.9305872+00:00",
"id2": 60
},
"db_language_id": "3fc7fac0-766a-47ea-bdc7-234b72e9af7b",
"db_language_code": "sample string 7",
"db_title_id": "89c37469-890e-4c36-8f7a-1e789ca17747",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-05T12:29:00.9305872+00:00",
"create_date": "2025-09-05T12:29:00.9305872+00:00",
"phone": "sample string 16",
"mobile": "sample string 17",
"email": "sample string 18",
"skype": "sample string 19",
"private_phone": "sample string 20",
"private_mobile": "sample string 21",
"private_email": "sample string 22",
"reference_back_office": "sample string 23",
"modified_dateutc": "2025-09-05T12:29:00.9305872+00:00"
}