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": "d8336ff0-76a2-4538-921c-5582498bcf44",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "140c268e-e7c2-4f79-8d86-916a31ba387b",
"company_code": "sample string 5",
"company": {
"id": "6fa57761-2160-4bf8-a69d-391841742fe5",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-17T02:33:46.2765613+00:00",
"sales_territory_id": "9845dd11-f816-4fcf-aeda-e15cbad4b7fa",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "abf1205b-a9d4-4d9b-b240-7fa9df73eecd",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fce865bd-550a-49e5-83ee-3508002cb6f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d8710b27-1191-4b32-a6a2-88d702df0779",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fa3faefc-d5ab-4a9c-b53c-5f317a40a779",
"db_currency_id": "cf84c3ed-f0cd-4185-b326-7df0fe4d9c84",
"db_language_id": "96f2b0d7-3215-46e3-8ee9-65dc0292598c",
"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-09-17T02:33:46.2765613+00:00"
},
"modified_dateutc": "2025-09-17T02:33:46.2765613+00:00"
},
"marketing_segment_id": "a4f4b119-7092-4c55-9af9-8bb105ccf006",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fa7740c0-9ca7-474e-b5d3-f71b1deee24d",
"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": "cac0fe7d-c7c8-4984-99e2-191cb97ab9b5",
"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": "c661b4ab-73f5-4212-9a73-4008b61eb98f",
"db_country_code": "sample string 28",
"feelist_id": "b5444970-e1c3-48c0-92f4-fbbafcf8299f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e11e2d47-4625-437a-a342-8e3aee7e6ded",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "22c08147-c4e8-4c6a-b90e-de9a4d3ddc61",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-17T02:33:46.2765613+00:00",
"db_currency_id": "99020182-e492-49a6-ac03-795cea6243b8",
"db_currency_code": "sample string 10"
},
"company_type_id": "380c594e-e2b0-41a6-85fc-c0df587bf375",
"company_type_name": "sample string 32",
"company_type": {
"id": "de36996c-cae6-4523-889b-ce580f840550",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "323d8e4b-261d-45f4-a60f-e50b9cc6c59c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "789d98e6-c414-4a24-93dd-75b228030370",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0aaae1fa-804e-41de-acf6-069e0963f03b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "522293fa-6855-4610-8078-79288a9c6fab",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b1134abb-8595-4b67-981c-81a7d364eeb9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-17T02:33:46.2765613+00:00"
},
"company_sector_id": "cbb7219e-0bb5-43f8-a8b8-d236124f1e0c",
"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": "fa63e975-b8fa-4e05-b92f-3451f5a74ba0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f829eb64-a67c-4f95-8cb5-5bd743b4f5e2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "110dbfe3-03b6-4883-b9b5-df397c4a0b85",
"account_manager_user_code": "sample string 56",
"company_status_id": "5678b8af-43da-4d22-8fe2-ca324772d098",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-17T02:33:46.2765613+00:00",
"id2": 60
},
"db_language_id": "aa530e02-8fc1-4c5b-a2c7-2bd359af8472",
"db_language_code": "sample string 7",
"db_title_id": "18f1af01-f7fe-4dc3-93cd-e007ea03ab81",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-17T02:33:46.2765613+00:00",
"create_date": "2025-09-17T02:33:46.2765613+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-09-17T02:33:46.2921859+00:00"
}