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": "9920e5ff-2a6c-47ef-a09d-ff56df7b09e2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "998771f7-e4c5-4f50-a7ef-919b24df9cc2",
"company_code": "sample string 5",
"company": {
"id": "92627522-25d4-4d9e-ae6e-bb4f23ad2b3c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-14T13:41:34.7440663+00:00",
"sales_territory_id": "6118dc0f-27db-4d23-b13e-3b338c7b1e2a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "75f0117a-9c6a-4691-8fcc-4b9d35557c91",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e794df08-f731-42a3-b423-538fb7772425",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "41b562a6-1550-4032-a918-807d557149ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c979053e-0d03-4443-b80b-d8b529c225c2",
"db_currency_id": "25a4ce3b-9ce1-4a63-b564-10bc7ca68b00",
"db_language_id": "4b14f04c-f96a-457a-959f-0d7916147a20",
"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-12-14T13:41:34.7440663+00:00"
},
"modified_dateutc": "2025-12-14T13:41:34.7440663+00:00"
},
"marketing_segment_id": "adac794a-ff58-4996-9651-f1de6b2fbf95",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a24e00ae-c611-40c9-b4e7-1f82929c0ab1",
"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": "8fd3a250-b1b5-4b7e-9a59-52ec2c6b677f",
"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": "829f9b37-51ef-4c44-9476-075535d15475",
"db_country_code": "sample string 28",
"feelist_id": "d2b6ffb9-1feb-4eeb-b101-239b99d67031",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "1ee0ed44-054e-4974-9dac-ed785e26c110",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "237bd02c-cf70-4273-b363-b99e4575eca4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-14T13:41:34.7440663+00:00",
"db_currency_id": "662c7d55-7c18-41b3-9e1b-5ba6a3e815aa",
"db_currency_code": "sample string 10"
},
"company_type_id": "ee8e26f6-4dcc-4302-b733-a87407b53a66",
"company_type_name": "sample string 32",
"company_type": {
"id": "312eef0c-d78c-4b0c-b26a-9c2bea49174a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5689f358-8b01-4cc0-aaa2-82d2dcfd778e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9ece8f3e-481e-4ddb-a0cb-db3736430453",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "be7f4013-6fb7-4853-aa9d-e9a4771a6fc9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cb0b882a-2d40-47f1-ac1e-f3db13f4b3eb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3755f052-224c-455f-a9cc-38904e04ba1c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-14T13:41:34.7596825+00:00"
},
"company_sector_id": "3d46ebab-7506-4be8-bed6-890c70ba4baa",
"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": "b28a4668-6b32-4d6e-8696-eb5b3728ad8f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "efe63633-dce4-42fb-85e3-2c7dd6235e15",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b10d967f-01f3-4e9d-98fd-221f5978e9cc",
"account_manager_user_code": "sample string 56",
"company_status_id": "78ee0665-852d-4882-85e8-617c3f6d7903",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-14T13:41:34.7596825+00:00",
"id2": 60
},
"db_language_id": "3f938f62-df1a-4e6b-bd7c-2323149b22fb",
"db_language_code": "sample string 7",
"db_title_id": "d97e24b4-9425-45bf-9d7d-b291cb1a2505",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-14T13:41:34.7596825+00:00",
"create_date": "2025-12-14T13:41:34.7596825+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-12-14T13:41:34.7596825+00:00"
}