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": "fd094836-5fe8-482d-808a-c101939ea2a8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "95a9d5d8-3128-4afb-bade-21d9fbe4b2a1",
"company_code": "sample string 5",
"company": {
"id": "f52d1b14-936f-4ef8-ba34-523234b2542c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-04T13:28:22.6168942+00:00",
"sales_territory_id": "ae292de5-77a4-4523-ac7e-64352f7b207e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "719b5ef6-3002-481e-8529-34fe17da2938",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "036361b8-6f40-4715-9331-939cf37de5b2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "87b433cf-58cf-4c83-bbd3-eae53ba7c5b7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5ef5bcf-af20-4413-913c-830c6ff4a4a7",
"db_currency_id": "2ff33d45-0cd5-42fa-a246-1877289e612d",
"db_language_id": "9366257d-986b-4a72-86a1-509729f64b68",
"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-11-04T13:28:22.6168942+00:00"
},
"modified_dateutc": "2025-11-04T13:28:22.6168942+00:00"
},
"marketing_segment_id": "7b27f288-7528-47cf-a08c-3a233b2daaa7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2a7bf11e-5ab9-4bbf-8f56-b72aa286e9b0",
"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": "89dd5946-7a5f-476e-b17c-13f0fe9d7b62",
"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": "35aa9176-724a-42b6-b2a6-772f1049cc22",
"db_country_code": "sample string 28",
"feelist_id": "62cb396f-3904-403a-9ad5-0927b5c4f08b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2f8666e3-704b-4621-aca9-74d1752b92d6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ad0660f9-be4d-4032-b3e8-a47cf1d3b552",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-04T13:28:22.6168942+00:00",
"db_currency_id": "75e7d35e-f2a5-4587-aba2-fb57d97f9dce",
"db_currency_code": "sample string 10"
},
"company_type_id": "a1cde135-684a-41b1-aa14-b4440d8f5e8b",
"company_type_name": "sample string 32",
"company_type": {
"id": "6b1d41c8-e73f-468e-b25c-eeab51543bd3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f94f710a-602d-46ba-b7f8-638b78fcf92b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bf6a39b9-7a66-4481-bcbe-410b9cfaa074",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aef527ec-cbfb-4ca9-87dc-e49f10e495e0",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "20e9fba2-4b88-4186-98dc-c506f3a55f11",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1d559a33-14be-4a11-9f75-3a3e910f25d9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-04T13:28:22.6168942+00:00"
},
"company_sector_id": "c4165f42-dd33-4b09-b3cd-8ac9baf32236",
"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": "f22b3bb7-085b-4fe2-b8b8-6252af343b35",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "15810551-f348-4c10-adfc-91028c1a5b93",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f7a7cd7e-13d6-4945-9b11-49a07d7e6175",
"account_manager_user_code": "sample string 56",
"company_status_id": "34fb30f6-d255-4d1f-ab29-908641ccdd96",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-04T13:28:22.6168942+00:00",
"id2": 60
},
"db_language_id": "fcce7374-b0f1-47ee-a5d8-975967a0d364",
"db_language_code": "sample string 7",
"db_title_id": "fef4519c-4c66-412c-8c45-abd4b20bbf52",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-04T13:28:22.6168942+00:00",
"create_date": "2025-11-04T13:28:22.6168942+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-11-04T13:28:22.6168942+00:00"
}