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": "63f10cdb-0d60-4bd7-9e75-e41baf180211",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "2f99ccf5-0145-4a83-9512-29f1b25b5bfa",
"company_code": "sample string 5",
"company": {
"id": "16b9ce4e-e6f9-4040-abef-a056f6aaf9d1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-07T15:10:47.4742387+00:00",
"sales_territory_id": "3f9c54ad-aad7-4f56-aaa3-34356d938ab5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "12ea8949-d970-48d7-b6fd-07670a5f8dbd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c0dab7dc-39e5-4b3e-bacb-b13f3283a609",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "67411ee0-e857-4877-a816-2245a3567cc8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f0e1f995-d70c-46dd-968e-61e8249fa76e",
"db_currency_id": "3acdb9ac-d4f3-46db-991e-69d66af5b556",
"db_language_id": "6734b6cf-39b6-4ece-9ea0-2fd91ec979fb",
"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-07T15:10:47.4742387+00:00"
},
"modified_dateutc": "2025-12-07T15:10:47.4742387+00:00"
},
"marketing_segment_id": "6b5a76eb-29ba-4756-aead-73e0bdbac78a",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8c92680b-5333-4f6b-af32-0b6dea118589",
"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": "51ad0c07-4299-45fe-9fd8-ce00fed3ab95",
"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": "10788af7-c1d9-4801-b68c-ea854107b8db",
"db_country_code": "sample string 28",
"feelist_id": "72233104-5571-4855-bdaa-d3cdd5187e14",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dcd7f44b-eaab-462b-8e96-1ec0ee4572d6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "49be08df-df96-4509-8fa5-22be9f29a77e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-07T15:10:47.4742387+00:00",
"db_currency_id": "f77e7c76-7504-4663-ba3c-f7ec780c4c07",
"db_currency_code": "sample string 10"
},
"company_type_id": "91a1e679-7bce-4122-a02b-ee3aa9c08ebc",
"company_type_name": "sample string 32",
"company_type": {
"id": "ac4e30b7-5768-4741-b84e-c311a1afb518",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "cfc7a686-2b73-44e4-9959-8a90f953e1dd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8e49619f-6044-4481-9dff-e695835739aa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "95af9c9b-8588-4140-ae6f-55407941a11d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c020d694-9cb3-45ab-b968-55c27f74ff51",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "477c8043-b915-4000-8348-c33c1dc2cd64",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-07T15:10:47.4742387+00:00"
},
"company_sector_id": "b7c6f737-0839-462c-b598-6611ba84a18e",
"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": "ba26329a-c23a-4285-9f63-b726a2290158",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "91f57c69-d819-4813-9506-20ad7b4fafe3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d4e928bf-c4f6-46f2-9b71-272f4dd66c76",
"account_manager_user_code": "sample string 56",
"company_status_id": "13804207-1014-451e-a391-ac1aa5eef304",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-07T15:10:47.4742387+00:00",
"id2": 60
},
"db_language_id": "b8db44d9-2a27-4aaa-9720-e5629c30f91c",
"db_language_code": "sample string 7",
"db_title_id": "f1573fdc-5404-4484-88fb-48aa3c76106d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-07T15:10:47.4742387+00:00",
"create_date": "2025-12-07T15:10:47.4742387+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-07T15:10:47.4742387+00:00"
}