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": "4d6ccf88-e3c7-4a34-ab97-af7064c241e0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f0f25c9e-5bc3-4591-8fc8-8975ce2b7021",
"company_code": "sample string 5",
"company": {
"id": "a7fe97c6-cca7-4a37-87e0-cd3ca6d54402",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-09T23:01:43.8973056+00:00",
"sales_territory_id": "a7bdccf0-158c-4162-b442-e48a214743bf",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1e9ec97d-1b1e-4a5a-b9d0-8d28a8ce1d0d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ff8484bc-6b9d-4c05-a261-30f48a71b92b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "787fde97-b8b8-4cd4-af08-d33661baff0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b97125e1-a11d-47b7-a9c7-200e8f73578b",
"db_currency_id": "88c17c48-e83d-4c90-a494-d07b9bb10c74",
"db_language_id": "641bd699-7b54-4a44-b124-da7f2c79e5e8",
"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": "2026-03-09T23:01:43.8973056+00:00"
},
"modified_dateutc": "2026-03-09T23:01:43.8973056+00:00"
},
"marketing_segment_id": "7c5f7711-9b09-4586-bc7a-fd54384b4b2b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "406cf5f6-12b2-4bf1-bef3-d5c9b9a196ca",
"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": "6759b49d-3501-4d7e-8453-6ca59ffcc796",
"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": "1f0b05cf-9d9e-412b-9efd-fff59a6ffdb3",
"db_country_code": "sample string 28",
"feelist_id": "ff25da87-b4cc-4daa-9a53-ff31be6387bb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9b981aaa-2bc3-4de8-ade4-dbfd334407cf",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8542a77f-5b15-4089-80ec-45e65b4eb18b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-09T23:01:43.8973056+00:00",
"db_currency_id": "397469fe-5305-4561-b21a-74c2a7dd95ba",
"db_currency_code": "sample string 10"
},
"company_type_id": "bf1d72c6-07ed-4da7-8fcc-59df3173a3ef",
"company_type_name": "sample string 32",
"company_type": {
"id": "40c173cd-8c95-4428-862e-f83933635f5f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fdb95d8a-e229-49c8-b316-8618bc4f979d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "93c51ff0-a454-4375-87c1-f605dd5aff36",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1d6c3dd8-2a47-4e10-bac9-674cfbbe0b42",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3c5130b4-a399-40b1-9d27-4d8b2b78739d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b953fe91-d93d-41ba-a74c-622874be0d94",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-09T23:01:43.8973056+00:00"
},
"company_sector_id": "9823a24f-5320-4c0f-9f57-91cfef1ec203",
"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": "207342ad-4dfc-4e1a-8503-b31b8ad21344",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "76421a65-a407-453a-b57b-3fd546e33e4b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "822c26f8-a2bc-474d-ba58-142ecda1c4b1",
"account_manager_user_code": "sample string 56",
"company_status_id": "9b601331-ee95-4f7c-a2a2-ab2539de15f5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-09T23:01:43.8973056+00:00",
"id2": 60
},
"db_language_id": "d4c6bc73-6326-4c8e-b91b-82bfcb2ce009",
"db_language_code": "sample string 7",
"db_title_id": "b7a07f6c-0c2a-4357-977d-cd8778342526",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-09T23:01:43.8973056+00:00",
"create_date": "2026-03-09T23:01:43.8973056+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": "2026-03-09T23:01:43.8973056+00:00"
}