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": "45660a24-8b3b-40d6-be7e-ef52a9a7b910",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f021d9e6-3a7f-4187-942b-bf2a948aac15",
"company_code": "sample string 5",
"company": {
"id": "aa0c3fe0-5a34-4c26-a76d-601c713fb6ae",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-23T03:33:52.5005607+00:00",
"sales_territory_id": "135a2781-9b25-4069-8421-8a80208b3ff0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ec82f96a-f92e-426e-a827-fcda013ebf77",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "146df886-0a48-4a32-8374-76def6a058a4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5d52ca8-ee12-4b98-99e4-7721e9276e7d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "efa856bf-9b00-4b1b-a452-21010a5a7226",
"db_currency_id": "7d45eda6-2d71-4cda-b73e-fdd581437fbb",
"db_language_id": "31a8ebd1-ef47-4a70-9614-a16601d228c2",
"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-12-23T03:33:52.5005607+00:00"
},
"modified_dateutc": "2025-12-23T03:33:52.5005607+00:00"
},
"marketing_segment_id": "2ce9d9e8-ebf8-4534-961a-156d905259b3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "2136064b-c344-41d0-862f-4d2945c9328b",
"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": "b068aff1-4da4-4921-a7b7-eecd4ed4e406",
"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": "a1088937-56f2-4041-bee7-f706a7f5c267",
"db_country_code": "sample string 28",
"feelist_id": "7261a62c-ab73-454d-bff7-6eba37c0d1a2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6dece49c-7f46-4c26-a384-9db8512833b9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5dd84a20-2054-45e6-ac4a-0faaa6fad47f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-23T03:33:52.5005607+00:00",
"db_currency_id": "697738f9-01b1-40e7-8827-231a49a75d03",
"db_currency_code": "sample string 10"
},
"company_type_id": "b3823a60-4ee2-4c8a-a539-e72e4f7ec22b",
"company_type_name": "sample string 32",
"company_type": {
"id": "b6ae30f6-032c-4cdc-ae46-1cc36d04ebf0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "729dc219-c81f-40f6-b7d7-1eda9aa1dddd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ff222f4d-8703-416f-b876-83dede5a7018",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "46a2346c-60da-4e90-b45b-e71417f11926",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "8686ffc4-256d-4215-97db-91ae751e4117",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4b0dbd83-5d46-47f1-8464-cad59191d61d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-23T03:33:52.5005607+00:00"
},
"company_sector_id": "f8dffc71-b5f2-41be-b97b-34e7eaa85aef",
"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": "eabb757e-f308-40f9-9ec5-e345ce7cb78c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a72675fc-d05a-4a99-b9c7-0f17fb13d7dc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d59235e9-df06-4b28-9d33-aa5969c17d8a",
"account_manager_user_code": "sample string 56",
"company_status_id": "0bb48d1a-2811-4a17-ba17-379d5c4a450a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-23T03:33:52.5005607+00:00",
"id2": 60
},
"db_language_id": "e0fd6e6d-8f35-4fee-a88b-706e951f0138",
"db_language_code": "sample string 7",
"db_title_id": "49657ee7-cbb3-47c2-a305-1d1ca57e4ed1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-23T03:33:52.5005607+00:00",
"create_date": "2025-12-23T03:33:52.5005607+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-12-23T03:33:52.5005607+00:00"
}