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": "282b5acd-19fb-4c36-a1a5-23aa01dea05c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "38c225e7-3ed0-4f74-a0df-1f3fa8cd0a4a",
"company_code": "sample string 5",
"company": {
"id": "f992a41b-45e9-4cc9-b5dc-1b7265747b1c",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-22T04:55:47.3959904+00:00",
"sales_territory_id": "4b6847ec-8096-40ac-81db-10f3028e3630",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "75c7ba94-6831-4c59-b8c5-8fe7d0a3a12c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4220024d-0601-439c-8e3f-aeae3451fab9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "96acdac0-9119-4403-a43e-80dc08e07d78",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1fbbdda0-c0c4-478d-8c49-a066b6474b5e",
"db_currency_id": "91a11e8f-df62-4a18-ba20-7e6ed5ce6844",
"db_language_id": "ceb5616e-8c21-4ae3-b5cd-79246c858bd0",
"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-22T04:55:47.3959904+00:00"
},
"modified_dateutc": "2025-11-22T04:55:47.3959904+00:00"
},
"marketing_segment_id": "fd0b3c21-c553-46b3-a6b5-76f57899eed3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6585b373-37e6-475f-a683-b2a4064aed2a",
"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": "01f7d9aa-3f4b-48d8-b2ea-075200706b98",
"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": "c21c7ce7-65dc-4d37-ba7e-18897afb423f",
"db_country_code": "sample string 28",
"feelist_id": "ea7dee4a-10ad-47f8-9fc0-925bfef6c5d0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "fa12e461-ef72-44c3-a2ff-2c067d7c188e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5d5355a7-2a9f-4b8c-a9c1-806411e1b227",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-22T04:55:47.3959904+00:00",
"db_currency_id": "b3367576-44bf-4f42-beb7-9c983968c9b9",
"db_currency_code": "sample string 10"
},
"company_type_id": "90818b90-556f-4228-a783-32e26e5028cd",
"company_type_name": "sample string 32",
"company_type": {
"id": "4105c1ad-0fa4-4963-a2d4-13c7ca1d5449",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "00b646fc-9c8b-483f-8c6c-c1ed072aaea2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fc4f0430-32f4-4387-be9e-cac474b59692",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4a9b7b62-a391-4405-a6fe-90d36656a5ae",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ae05d0ba-0feb-4fb2-85af-f51b032ce280",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a52a0e1d-c05d-437b-9613-b883bb563853",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-22T04:55:47.3959904+00:00"
},
"company_sector_id": "05a4a7e7-ad05-4a58-9f44-0d995a2f0683",
"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": "640f54ee-77ce-4701-9886-46360b91d7cd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b0e1f53e-c8f6-43ae-9881-7cbd8dd043fd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "efbff356-1a4d-4ea2-8b00-0abcdcd1a7fc",
"account_manager_user_code": "sample string 56",
"company_status_id": "23151ac6-2c68-4e04-979d-39b292412fd2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-22T04:55:47.3959904+00:00",
"id2": 60
},
"db_language_id": "94d17f40-e110-4370-aeee-8d717e25122c",
"db_language_code": "sample string 7",
"db_title_id": "ff031e47-d1f4-4b70-a40c-cb76b035452d",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-22T04:55:47.3959904+00:00",
"create_date": "2025-11-22T04:55:47.3959904+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-22T04:55:47.3959904+00:00"
}