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": "ad7a6cf7-5b32-47a8-9f1f-cecf7acce512",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "776b6a82-f095-4a46-8b70-b07332946336",
"company_code": "sample string 5",
"company": {
"id": "93d18302-a4ca-4720-91eb-650af69f3a59",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-05T21:51:26.0052233+00:00",
"sales_territory_id": "592e688a-d3be-47f4-af2b-aae812c72236",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "994d08e2-1071-42c6-9bba-10171dfb32a7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f34915ba-5705-4b01-83bd-1700518c86fa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "37987849-69f9-4207-b602-750d1dd221bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "39332e68-1237-4969-89ab-af0c704408da",
"db_currency_id": "d359f6b5-8122-4edc-9c0a-377a0fcf3b99",
"db_language_id": "831219ba-dc91-4512-bc46-3e8ea9e147da",
"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-07-05T21:51:26.0052233+00:00"
},
"modified_dateutc": "2025-07-05T21:51:26.0052233+00:00"
},
"marketing_segment_id": "82eb590a-a72a-4fde-b0e5-ef5c2ad26961",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6794c89a-194f-4688-8f8b-4f85eff5364c",
"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": "af6eb10f-4494-4018-abf5-ad9d3cd3c6de",
"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": "5b7cf938-fe19-4f33-8687-e8e9df5a7df6",
"db_country_code": "sample string 28",
"feelist_id": "27bed65d-350f-44f4-be1f-1f2a87dfbc78",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fe753bde-458d-4979-8fc7-ba93bee6b750",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "cebd6b70-450c-47e0-a09c-34a9306d5773",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-05T21:51:26.0052233+00:00",
"db_currency_id": "74a5ab66-f41a-4184-a13c-22dbfe96d6ca",
"db_currency_code": "sample string 10"
},
"company_type_id": "01b18d90-3e16-4bad-9ffa-f8900e826e47",
"company_type_name": "sample string 32",
"company_type": {
"id": "1acfd7ad-9ed5-4a4e-b86d-7a2fa4c50dfe",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5154fe27-8730-4934-b159-14dc8c6c6c1b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "072e6a5c-0b10-401b-97fe-0f01c1fe248d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "37959722-2bb4-444f-b12f-0bae1b66e7e3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "658a4cc2-ae4c-4fff-b886-a41ecdcc4c18",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ff347475-bd85-4b46-a1ad-f67baebff58b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-05T21:51:26.0052233+00:00"
},
"company_sector_id": "c45d82f0-5aeb-49ea-bcdd-95001a3a9f13",
"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": "1abe66d2-052d-456c-8c46-52efde043b76",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "40bd9a0b-a454-4c0f-94b6-48bfba2441cb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "74081227-83cd-4cc2-9542-12248c0c4ec7",
"account_manager_user_code": "sample string 56",
"company_status_id": "59268d1d-2286-47be-bbcf-aaa44cb73720",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-05T21:51:26.0052233+00:00",
"id2": 60
},
"db_language_id": "232cda20-b4f5-4251-8adc-ff1fcd217080",
"db_language_code": "sample string 7",
"db_title_id": "6c8b0d44-81d6-4cee-977f-459a35165ad2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-05T21:51:26.0052233+00:00",
"create_date": "2025-07-05T21:51:26.0052233+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-07-05T21:51:26.0052233+00:00"
}