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": "9124bfec-54f8-44a6-bf57-a027fa5c7d99",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f0023ad7-15fd-4b92-9982-06d57e3aa7ba",
"company_code": "sample string 5",
"company": {
"id": "3f55a1d7-a938-4680-9e1c-3156bbb94035",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-23T07:06:04.0492477+00:00",
"sales_territory_id": "f4716f5b-2fc5-42d3-97e1-b864954aecc7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2d1073a6-1b16-477f-a7fc-862d18663e2e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ab7405f2-1fc3-45db-a2ac-62d8a7d125fc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7501198a-759f-46f9-97ec-2024404a981d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "922a8d21-ca2b-4ba1-9e44-3e53c29de86e",
"db_currency_id": "ee463449-1c0a-48cd-a348-8c49ca918348",
"db_language_id": "75394c0d-c648-4113-8de3-33c7dc4e90d2",
"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-23T07:06:04.0492477+00:00"
},
"modified_dateutc": "2025-11-23T07:06:04.0492477+00:00"
},
"marketing_segment_id": "ea34db7f-e41e-4647-b36b-2f212221b142",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "4a053d8d-6b5e-4f77-a90d-7b762e2afb99",
"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": "41e2564a-e827-40d4-99a1-0f61b0b04ca8",
"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": "6e946f39-9e38-4245-a281-d07a3bad6a14",
"db_country_code": "sample string 28",
"feelist_id": "26c4ab51-82a2-4cf2-bf65-ff72627e630a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0e70a7d1-3a61-4373-92f5-7ef06128a568",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3420f428-046d-4209-b423-503a0b891dcd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-23T07:06:04.0492477+00:00",
"db_currency_id": "38988eab-b117-4a3c-90a0-1f37b218b7ce",
"db_currency_code": "sample string 10"
},
"company_type_id": "3d9a8eeb-ff7d-4619-997f-6fe6af6eced6",
"company_type_name": "sample string 32",
"company_type": {
"id": "5d797405-a109-4deb-a9f4-1ed37afb2cde",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c72790c0-3cc2-4f04-9cf0-f111f91028f5",
"sales_organization_code": "sample string 5"
},
"db_language_id": "27ca6040-3522-493e-b61b-a8ad81943381",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6f66fc35-4a86-40da-ab3b-fd3dbe9f50ac",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "3d5d048d-de4d-4c03-93a9-8430c9e690a0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ef054876-f0b3-4673-84aa-3fb8a9b7bd16",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-23T07:06:04.0492477+00:00"
},
"company_sector_id": "3a640f04-66ed-46e1-a8cc-80330ea0e3d3",
"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": "d3154f51-13f9-4fb2-a7f3-fa62b1c37300",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "64bd3dba-2292-4c9e-b529-a2b8b9d3b863",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a1e8a4f3-088b-4085-883e-6540ec644b6a",
"account_manager_user_code": "sample string 56",
"company_status_id": "b9ebd516-ebc2-43f4-9f9b-8dbe4b944f49",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-23T07:06:04.0492477+00:00",
"id2": 60
},
"db_language_id": "27c76531-4981-4e27-b275-0e3d5b11908f",
"db_language_code": "sample string 7",
"db_title_id": "88c0c113-241f-4bf4-a96a-91a4f7aca3d7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-23T07:06:04.0492477+00:00",
"create_date": "2025-11-23T07:06:04.0492477+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-23T07:06:04.0492477+00:00"
}