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": "0e1469ed-314a-417c-a9e9-1e02ee8ae36d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "80efa7fc-2e33-4b9c-ba5a-05d2ee0b5477",
"company_code": "sample string 5",
"company": {
"id": "f385fb9f-ab96-4f91-b295-fc6e33d46107",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-15T04:05:44.1442709+00:00",
"sales_territory_id": "8cbb1a9f-16b9-4459-bdc3-95751c7c22e7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b41b1efc-8686-4b4f-a851-a5c9af35ba50",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "accc5b47-034d-409d-82ce-a24fc45d5e88",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5e93f9bc-452e-4903-9b00-774a872080fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0d0b0574-605c-413b-a36f-939e1f7f1194",
"db_currency_id": "faa5fbf1-c32a-422f-8739-9516f64722dc",
"db_language_id": "1defb66b-8d3c-4276-9696-34553f086e21",
"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-10-15T04:05:44.1442709+00:00"
},
"modified_dateutc": "2025-10-15T04:05:44.1442709+00:00"
},
"marketing_segment_id": "116da4bc-d7c8-4814-8287-148faa5ed95b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c5291526-0038-4674-9053-0c72f75bb459",
"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": "028ca788-b11e-45bd-bc74-a4cd77648ae0",
"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": "fb8c815b-c9f2-47c2-af89-496f1b2e7246",
"db_country_code": "sample string 28",
"feelist_id": "ab185563-3a7d-4707-97a2-43a70410af5f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a2d87178-228f-4cc0-bfcd-e7eca1eb056c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "762d0b50-3829-4c56-ac54-2dcc0f063205",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-15T04:05:44.1442709+00:00",
"db_currency_id": "2bf2617a-2388-4769-9aa2-902bd4b4884c",
"db_currency_code": "sample string 10"
},
"company_type_id": "b735e88c-28c9-40be-a67b-be93d1c22c45",
"company_type_name": "sample string 32",
"company_type": {
"id": "01c31527-f416-444f-ac87-c7f5b31d263a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c2dd15ac-25a2-4413-815d-0bb3cd387a4f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "162a29cd-6408-41a1-8bdf-301516f3188d",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "94a5aea7-6a91-4de5-a861-48ab918ac1ca",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8f4d1566-2be2-4723-9b89-777488dd408e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "81a4a35d-1fda-45c6-92b8-f6a2d73f4269",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-15T04:05:44.1442709+00:00"
},
"company_sector_id": "93df6d6c-18e2-4048-a606-9b9bde7df3fa",
"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": "0ac8e2a1-1be5-46de-aaaf-9a3e01042de4",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "01737258-e834-4910-97a9-e891ebebb38b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d58afbfc-9305-4c55-a821-9f5440010583",
"account_manager_user_code": "sample string 56",
"company_status_id": "9eddda9d-ffc4-4aa1-a2c6-7c5507376eb8",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-15T04:05:44.1442709+00:00",
"id2": 60
},
"db_language_id": "d89fab19-2e2f-412d-a797-22412c42b0da",
"db_language_code": "sample string 7",
"db_title_id": "0cfcc525-8726-49ca-b11c-bacf34eba6ad",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-15T04:05:44.1442709+00:00",
"create_date": "2025-10-15T04:05:44.1442709+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-10-15T04:05:44.1442709+00:00"
}