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": "829b2e47-96e5-43c2-a239-c933155bb6f4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "75621f89-f833-412c-aefa-f8d3c5565fac",
"company_code": "sample string 5",
"company": {
"id": "be3d89b1-7b52-4f58-afdb-6ceb9b8e4470",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-25T23:09:38.9166163+00:00",
"sales_territory_id": "8d0f149c-0bf0-41df-bbea-92d19bbd41e7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a5a1b419-72d0-40e5-ba80-c8098a07ad99",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5b54ce1-d21b-4745-afb2-b705a58ded63",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "166f1b92-2a2c-4357-aa2d-ea768f9134a9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d12f4a58-0e46-4b85-a34e-a4bce65b637d",
"db_currency_id": "0ba07c9b-057d-46ff-910d-a11b0f4f2c14",
"db_language_id": "9dc587cc-cd77-4840-87fc-c4c4548eef78",
"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-11-25T23:09:38.9166163+00:00"
},
"modified_dateutc": "2025-11-25T23:09:38.9166163+00:00"
},
"marketing_segment_id": "b84ed16d-659d-410e-8869-035f0d4c3c2e",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "81b3be81-b47e-474c-97fa-0c5fd49daa18",
"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": "f937a236-bd2a-4c15-9e40-f5bee845862e",
"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": "be00b6d9-54dd-4791-8090-564c9186dc90",
"db_country_code": "sample string 28",
"feelist_id": "ed8bfc35-55a0-4e00-8e56-f052a19ff3b0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d8303e11-5bcf-4e78-8f08-2249f9dd3cdb",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "04a36684-07aa-47e9-8d9a-7361adb5d3c3",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-25T23:09:38.9166163+00:00",
"db_currency_id": "298111df-32ca-4605-a723-86f0ec343509",
"db_currency_code": "sample string 10"
},
"company_type_id": "7bc4b717-3ab2-48ab-8bc7-4d0d73079bd4",
"company_type_name": "sample string 32",
"company_type": {
"id": "42631acb-c171-4e67-a14f-b915d4ba8471",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "65d97b28-6166-4aa0-b3cf-774c6b9443b2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d8468bf8-4f7d-4782-ae97-8c47197390f3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6109bfd9-e1f7-4599-9648-33b1d3cd8eac",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7b3c97f3-e834-4b5e-9f41-fd0696481470",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "16b211a0-0730-48fc-84cd-4631bfd91818",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-25T23:09:38.9166163+00:00"
},
"company_sector_id": "bbbcb08e-c63e-4cb3-8888-96d0da870976",
"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": "0e3e48bc-a9d0-471c-8992-39c50298200d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a630fe01-9b2e-4589-b14b-42974d828241",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bb6456fc-39a1-431e-8d11-1adc0b652300",
"account_manager_user_code": "sample string 56",
"company_status_id": "72de11b0-9fd8-4969-86f6-5b9477b43ff0",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-25T23:09:38.9166163+00:00",
"id2": 60
},
"db_language_id": "55ae7f12-e6fa-414e-a8cd-6fd652123c2b",
"db_language_code": "sample string 7",
"db_title_id": "c3b6b607-acaf-4b50-9ab3-030aa108f70e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-25T23:09:38.9166163+00:00",
"create_date": "2025-11-25T23:09:38.9166163+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-11-25T23:09:38.9166163+00:00"
}