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": "bd508983-68da-4529-aba9-cc7377e65a4a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "3af0981f-ea5e-4bee-a355-eeb12ce3639e",
"company_code": "sample string 5",
"company": {
"id": "cfb04611-7b94-41dc-878f-3269430cce77",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-15T18:16:52.1207444+00:00",
"sales_territory_id": "735552f6-6577-4eb6-9499-d7a8a8a26eac",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ee06d6ff-22d8-45b4-abb5-4ee61a0e741d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c88ade82-3c03-41be-94ad-83bca2d76b4a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d830bed-d685-4d02-a614-a004588362c6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1a8eb2c7-00b0-4957-859c-d908b52ac324",
"db_currency_id": "38a8cb65-e207-4a53-b643-543699072ec0",
"db_language_id": "4f00828b-221a-4c1e-91d1-5a3a994f5534",
"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-15T18:16:52.1207444+00:00"
},
"modified_dateutc": "2025-12-15T18:16:52.1207444+00:00"
},
"marketing_segment_id": "28f6051c-ac0c-4507-a8b1-0dc8b6355dd3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "86fd25e8-dddf-4bb7-a716-e642b0ec7fcd",
"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": "7f318e0a-b538-4e07-a601-e84f373bf705",
"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": "fa7b3880-132e-460b-996e-7dcf22594461",
"db_country_code": "sample string 28",
"feelist_id": "71a06bd7-eae0-41c2-87ef-ad36f66e0180",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d8446855-9ee6-4ea4-9c8c-abea86445e8e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "941984c8-5be0-4501-b93b-68834a5d6a02",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-15T18:16:52.1207444+00:00",
"db_currency_id": "b250d8c4-b8cf-46d4-9fd7-cdec05523226",
"db_currency_code": "sample string 10"
},
"company_type_id": "4cdd48ff-ff45-4e53-9bc2-95e965406d41",
"company_type_name": "sample string 32",
"company_type": {
"id": "865c371e-3038-4e6c-9833-c46cbd2156ce",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0be32b09-73f0-4eb8-835e-751d4922594b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "0b50c5c5-76e4-4475-a125-801036e243b1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ffc27154-6225-4c9d-86b5-b26d325ff57c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1024be59-9beb-41ce-92eb-155f5b1e5724",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3109d6a6-90cd-4e3f-bbc7-34932ae4d687",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-15T18:16:52.1207444+00:00"
},
"company_sector_id": "e2de29d4-023a-4065-8365-d628d3e07547",
"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": "dd201a0f-b69a-4d33-ac46-b5905a0d49f9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ea3b9363-6a4b-4346-8b93-aca0445dbb1b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fb93dff0-bbbc-4ffe-ba41-f70a73a896ff",
"account_manager_user_code": "sample string 56",
"company_status_id": "9f2e4857-759a-4bd6-93f5-2d851889126e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-15T18:16:52.1207444+00:00",
"id2": 60
},
"db_language_id": "47ce4e16-c997-4d2b-b3af-bbdd0c6368cc",
"db_language_code": "sample string 7",
"db_title_id": "9d1309e1-b17e-427f-8c71-cba1078b0fbf",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-15T18:16:52.1207444+00:00",
"create_date": "2025-12-15T18:16:52.1207444+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-15T18:16:52.1207444+00:00"
}