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": "c186ec23-b100-4412-94f7-d0e58d254708",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ab9aa49e-63c8-4dbf-87e8-d5a252668df6",
"company_code": "sample string 5",
"company": {
"id": "b5017f04-4e3a-4092-a635-42011e9ac1aa",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-20T20:09:06.3824084+00:00",
"sales_territory_id": "d8102cf2-0697-4be8-9355-e5a8ecf15dfc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0d6ac998-07dc-41d8-919e-b768637040da",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "97e9803b-ab1f-4523-a37d-2aaaa7af801b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2ac82308-cfa7-4096-bae4-eae076c945f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "eacc0bd1-70ba-444e-ae55-7caaf839e73f",
"db_currency_id": "bf1b73c1-1ae0-4e01-b9eb-92bdd14ea442",
"db_language_id": "3b7777e9-b615-4307-bbc7-156b5c4f4e66",
"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-05-20T20:09:06.3824084+00:00"
},
"modified_dateutc": "2026-05-20T20:09:06.3824084+00:00"
},
"marketing_segment_id": "ebfd64e8-9a26-4875-a09a-26658bc8ea9f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "866ead4b-615d-440a-bded-f74d3705650b",
"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": "c593b6a3-a905-46f3-ac2d-e93e7723eee7",
"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": "997d3646-1ed4-4284-a478-c6e44638d6de",
"db_country_code": "sample string 28",
"feelist_id": "5c0ed281-9b2c-4980-a763-67425bc05081",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bad56936-5ba5-4f89-85e1-7e1e96a19c7f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "599b9240-6658-487e-b1f9-08d99a7c0240",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-20T20:09:06.3824084+00:00",
"db_currency_id": "00d3f4e2-2fd9-4a76-a816-295aa040b541",
"db_currency_code": "sample string 10"
},
"company_type_id": "5e996e17-666e-4054-b311-e4e8e7698457",
"company_type_name": "sample string 32",
"company_type": {
"id": "54062f46-429d-4384-a01b-d490a56a5058",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f4afca23-af8f-427c-9872-ed6ce2184875",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fac26cb3-3f5f-443d-a405-3970e70e89d4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c19ac09b-ad1b-43fd-9a7e-4fbedd311a04",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "55a2139a-5cd4-415b-ace8-13d4b92ef94e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0f621e51-79e2-48b5-9fae-575a135d55fa",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-20T20:09:06.3824084+00:00"
},
"company_sector_id": "966dee01-6cd6-4724-80a4-46006cdc469b",
"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": "0c106255-7c24-47bb-bf04-45f4af126428",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "68fe1ac3-cbf1-44e5-8989-279bd1d5e73c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "5aa91de0-c04f-48f1-b49b-163e259879de",
"account_manager_user_code": "sample string 56",
"company_status_id": "068367dc-ead6-4cb4-a587-64d82a34c959",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-20T20:09:06.3824084+00:00",
"id2": 60
},
"db_language_id": "156bc5b0-9f56-4844-a022-047c39a72ac0",
"db_language_code": "sample string 7",
"db_title_id": "05544c7e-9fc2-41ba-8a0f-cb7d6ace6168",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-20T20:09:06.3824084+00:00",
"create_date": "2026-05-20T20:09:06.3824084+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-05-20T20:09:06.3824084+00:00"
}