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": "01100c74-277c-4e7e-b798-a73fa838f670",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "26e745fc-8add-4b23-aaf9-e5f7141c30c8",
"company_code": "sample string 5",
"company": {
"id": "022dbcf2-7f9e-41df-b364-47dd52a243d3",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-04T04:27:49.3991762+00:00",
"sales_territory_id": "744e3878-3898-48e3-9d02-3f05e09cd9a9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2e6b1e22-44a1-43c1-80b7-f18d912063fd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "961c0de7-a17f-4bd2-9e6e-a1f3282131e1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c2be2757-5928-4382-b8eb-e19fed65a398",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3ec1cee5-3ae7-42ef-ab44-11f4c773a644",
"db_currency_id": "0deb5e10-f945-44b2-a490-c4c0f4676ece",
"db_language_id": "a0adccab-19e4-4c8e-b140-0ee7ab8a40e1",
"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-04T04:27:49.3991762+00:00"
},
"modified_dateutc": "2025-09-04T04:27:49.3991762+00:00"
},
"marketing_segment_id": "3ea3edc6-fd29-46c1-bf11-433a8a8f4346",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c88e1733-82bf-48d4-90b0-236837e478f4",
"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": "4eb3bfd0-36f5-45d1-8c90-2f756a337420",
"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": "606041b3-7af6-491f-a401-cdc4011c8fbd",
"db_country_code": "sample string 28",
"feelist_id": "816a8555-91e3-460b-ac26-095d8552c22d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d7dbfbb4-b090-44c6-b5f9-b4d113d3ef79",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fa092ad6-ced7-4797-a93a-0139f29fe0c6",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-04T04:27:49.3991762+00:00",
"db_currency_id": "337b481c-6989-4ad4-a9aa-6298aaac3f57",
"db_currency_code": "sample string 10"
},
"company_type_id": "539a4baf-34fa-4046-9ac1-a66d091a50fc",
"company_type_name": "sample string 32",
"company_type": {
"id": "2b0681f1-3e84-408c-978d-1182d561b052",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "72450c1f-c9c5-4271-8ad5-fc36dbbce8bb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "69d7832a-3413-4b6b-a242-875f5aba5b6d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fb7b59fc-b3c7-4123-af03-ffffcc446571",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e632774d-e8fe-441e-9c0f-026fd000d59e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "17012c0c-890b-41f3-8ba8-f801869ebc0c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-04T04:27:49.3991762+00:00"
},
"company_sector_id": "5ba9351f-0b10-4465-b41b-31f6b614a1fe",
"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": "3a01d718-108d-449b-a644-92a911761fd1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "85f958b5-0f73-42d0-bb11-14bab32d9e85",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8549c1c7-5be8-480e-8923-002ccd102e65",
"account_manager_user_code": "sample string 56",
"company_status_id": "846a657f-626a-47ea-b4c9-9a96d2fd9893",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-04T04:27:49.3991762+00:00",
"id2": 60
},
"db_language_id": "abc3b4cd-9205-461f-9154-dbe3e487b96f",
"db_language_code": "sample string 7",
"db_title_id": "c668a0c1-a5c4-44b4-a3fb-5e08475e8b16",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-04T04:27:49.3991762+00:00",
"create_date": "2025-09-04T04:27:49.3991762+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-04T04:27:49.3991762+00:00"
}