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": "c0c776dc-0ce5-45d2-92cc-e914edeeddf4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7ef93c6c-9bdc-402c-8d19-128970aa98cc",
"company_code": "sample string 5",
"company": {
"id": "4bcba016-196d-4001-951f-7a64531cd659",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-13T23:42:35.314177+00:00",
"sales_territory_id": "67ad3869-73a0-43a7-8a6e-357722533200",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "23fc328e-fc71-4b7e-b653-6cbe02e72959",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "22cf0f45-4d6d-44cc-979f-921dbaf4f966",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ee88e78f-1083-4da3-bee7-8761aec04d8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0bdbcb92-ac67-4969-b9d9-7dfec9808052",
"db_currency_id": "31cee117-3e37-4356-8a45-295fd4dcb6ea",
"db_language_id": "e67903f3-e5b1-4283-93b2-94bd2a8c006a",
"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-07-13T23:42:35.314177+00:00"
},
"modified_dateutc": "2025-07-13T23:42:35.314177+00:00"
},
"marketing_segment_id": "a064e6c5-2c02-43ac-982d-2d80ad5efdd4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "75d92683-8784-4e6e-a28d-e8ae58b5ea4c",
"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": "03eb8a09-7bf2-42b4-97eb-d15d2f33ba43",
"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": "ee162341-c76f-4fcc-a733-a50c91e0b957",
"db_country_code": "sample string 28",
"feelist_id": "06b094fd-4c82-46ac-8ab2-ab6ac6c05890",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "308fe6f7-14a9-4673-be9e-8916268aa30e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bf34a42f-0d92-4f78-8046-a0768509619a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-13T23:42:35.314177+00:00",
"db_currency_id": "4b391ac6-fa44-42eb-9448-753ff34a18b4",
"db_currency_code": "sample string 10"
},
"company_type_id": "5e54ccec-d09c-4694-b164-37b6a5c781b0",
"company_type_name": "sample string 32",
"company_type": {
"id": "0376687d-ce16-4679-8fb1-7b31af9b062e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "58cd7e92-d9f5-4174-a887-f7e638350d94",
"sales_organization_code": "sample string 5"
},
"db_language_id": "44587cec-7135-43d9-bcc4-23e75ef107ed",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "90c806c7-6872-4b04-87ca-6d266e668bef",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "88f4fa82-85ad-4fba-9787-0e6db0d32b50",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3ea115a5-f3f5-4886-a1aa-2bbad3444367",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-13T23:42:35.314177+00:00"
},
"company_sector_id": "b5f37e96-f15d-44ef-968e-2eba22a0e908",
"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": "41dd57ff-83ed-4fe7-94af-96e856dec757",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5551a92c-3012-4f7e-8e6d-a8ec1022d3f4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fb6cd62e-c31d-4741-881b-ecdd9a3561ef",
"account_manager_user_code": "sample string 56",
"company_status_id": "172adcb7-cc7d-418f-b5b2-bf8309862e02",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-13T23:42:35.314177+00:00",
"id2": 60
},
"db_language_id": "809fca79-1874-4d47-b0cb-a903d3718efc",
"db_language_code": "sample string 7",
"db_title_id": "a5fe2444-3814-4ee7-8de0-1898159cc270",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-13T23:42:35.314177+00:00",
"create_date": "2025-07-13T23:42:35.314177+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-07-13T23:42:35.314177+00:00"
}