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": "48b5c0cb-6fdf-4fc5-8f7d-4a31a93d2caa",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f47dffb1-1b36-41c2-9cbc-3594b0c4e309",
"company_code": "sample string 5",
"company": {
"id": "47cbcadc-a045-4ef5-bc7a-22d70712a128",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-08-12T12:52:04.5307017+00:00",
"sales_territory_id": "6951b193-9c3a-480d-a20f-de80d5b59efc",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6f75b440-320f-493c-a429-df717bbbad09",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "80967598-d453-4a12-b880-efb850e5ddab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a48207ec-0e0f-4868-9730-98fc84d02fee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd70f864-8658-4c05-aa7b-f10f75eddc63",
"db_currency_id": "915ae51c-4feb-4ab4-87a8-cf87d9f5d3f5",
"db_language_id": "bb378e61-f1d5-4e44-9b4f-5059ee5746cf",
"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-08-12T12:52:04.5307017+00:00"
},
"modified_dateutc": "2025-08-12T12:52:04.5307017+00:00"
},
"marketing_segment_id": "2f39ee9c-7d2c-4994-9fe9-f65d1516aabf",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1ef61177-db37-4d20-bc03-f43b5a1fa1cf",
"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": "a025c5e2-15d2-4492-90ca-368000923753",
"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": "33a953e0-e62c-463d-8a77-ba62f39fa2d4",
"db_country_code": "sample string 28",
"feelist_id": "dfa23175-7e3e-4135-9394-9a63af05b0c4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "000cb783-4489-4ddc-b8d5-88f42571c505",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8f4849f1-9b50-423e-bb9d-18aac8a4cb50",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-08-12T12:52:04.5307017+00:00",
"db_currency_id": "93b7bb4b-59bf-4331-9eff-c44cace934a4",
"db_currency_code": "sample string 10"
},
"company_type_id": "84ad3998-1e5b-434f-8b24-baf61a99895b",
"company_type_name": "sample string 32",
"company_type": {
"id": "40d96d99-9512-49fd-9adf-0927b91c8d5d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2ec26e57-830d-4457-b028-1acd9e9c31bb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3b51826b-5353-4e9a-a8e2-a1041e710cd3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b4bdae4c-7262-4e7a-b09c-da5ae3fa27a1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "76c8afca-346f-499c-955a-c49fca1a1d84",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3f7d8182-9cb6-4539-b240-1c550592c583",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-08-12T12:52:04.5307017+00:00"
},
"company_sector_id": "180bb527-f5ec-414a-887d-40bd3b3fcc33",
"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": "85d40209-a8df-40be-a6a8-af4c47eb07fb",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "df2d50b5-82d5-49d8-8c1d-45c362ee117e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bbf45701-82a2-424c-9644-60c71f2d8f25",
"account_manager_user_code": "sample string 56",
"company_status_id": "a7f2062d-8ab4-4ed8-b27d-0f59d79dc2a6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-08-12T12:52:04.5307017+00:00",
"id2": 60
},
"db_language_id": "debd5380-7639-4d70-b4a9-335ad0ee9069",
"db_language_code": "sample string 7",
"db_title_id": "15fa2731-2674-42dd-bf4a-9566988ba7c2",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-08-12T12:52:04.5307017+00:00",
"create_date": "2025-08-12T12:52:04.5307017+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-08-12T12:52:04.5307017+00:00"
}