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": "1f0da777-0ce5-4da5-9751-786ceeb45d41",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a77666d2-2e80-40f0-9ef9-ef3f307415f6",
"company_code": "sample string 5",
"company": {
"id": "ef707621-7079-4365-886f-41b2f862bfa7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-26T11:24:08.8721773+00:00",
"sales_territory_id": "4f3b4994-bdd9-4221-8a7c-c08be61aa9c6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ecd54500-5ec1-4aca-9838-5e82745a3e95",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5c49bbe0-bb49-4feb-8a93-bbc5ec7daf09",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3cf6f3b3-c222-49b5-bd89-e19ca18fe537",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dea009ec-c1d3-4767-86dd-b920ee51a963",
"db_currency_id": "050eb5d0-bec9-48bb-84cf-832381d5b804",
"db_language_id": "ba2e6c16-0f40-4cf4-a59b-293a73a4da1a",
"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-06-26T11:24:08.8721773+00:00"
},
"modified_dateutc": "2025-06-26T11:24:08.8721773+00:00"
},
"marketing_segment_id": "ee552cc6-119d-4c9e-a9a8-d4fec9ce8c5a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b44922bb-27c4-482e-8473-fb2c0f64f289",
"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": "088727a9-276b-4bba-be6c-87b3f4b78b61",
"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": "6dfcf909-dfde-4b91-a899-9e1ee0af17fd",
"db_country_code": "sample string 28",
"feelist_id": "53daa5b7-f544-44a9-ad26-e52fc9ea7272",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "681f5a44-013c-482e-8f52-aef6f478665d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9f62e2f0-6806-4ac0-bebd-9865342266c4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-26T11:24:08.8721773+00:00",
"db_currency_id": "dbcc309f-6c9c-4b60-80c9-0a3353bfd598",
"db_currency_code": "sample string 10"
},
"company_type_id": "f3e1090f-4016-4c7b-a54f-2b05b8cecce9",
"company_type_name": "sample string 32",
"company_type": {
"id": "154049cc-bf5c-4622-9b9b-6f3d8b1cbe94",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3dc7d68e-fdb8-4c91-bd03-5f4b6d558224",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d28ac802-2592-46bf-bcc9-8ed3c51e8fe9",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e1c58ceb-6e6a-4139-97cd-4f839a4e4c09",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c9c19d36-8197-498e-bd66-ba0003c9b444",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "71f1ddc5-9c8f-4464-9729-817673fdda30",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-26T11:24:08.8721773+00:00"
},
"company_sector_id": "5560803d-4694-4ed2-804b-18efeafccbcf",
"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": "bdacd844-f8f5-4453-a95d-a4454e8383c7",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2b89ddd2-7a14-4f07-aba9-f94d77af5d9c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "221c5629-bff4-4b92-8c76-4994a8a1534e",
"account_manager_user_code": "sample string 56",
"company_status_id": "b106a613-68b1-457c-8567-f2a0c3508968",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-26T11:24:08.8721773+00:00",
"id2": 60
},
"db_language_id": "120e366b-5a2f-4be0-8398-a2a7dabca926",
"db_language_code": "sample string 7",
"db_title_id": "c07247ad-55d2-4e9e-b732-b53f7124bcaa",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-26T11:24:08.8878036+00:00",
"create_date": "2025-06-26T11:24:08.8878036+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-06-26T11:24:08.8878036+00:00"
}