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": "cfd3d316-e096-477c-ac1b-b483e21d982d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a6d28cfd-1e19-4e50-9e16-37bad4b89fef",
"company_code": "sample string 5",
"company": {
"id": "d43cd6a5-db89-4165-8bf9-3ce174ecdd88",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-20T11:17:49.8027234+00:00",
"sales_territory_id": "c3ef7bc4-ea79-42bb-825c-37a32a1db12f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "aea9f08b-4a30-4ced-bd89-7aa88df08460",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5e2fb89-f118-4614-b503-e694b6fd9911",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cabbb9cb-a8c1-4a22-bcdf-1e4a467bd117",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56d1352e-0509-4777-819c-33a56fc16f92",
"db_currency_id": "5faee666-23cf-4557-a198-1f3a19dc7450",
"db_language_id": "7425d59f-cf68-4af6-a33e-1e93771fd8de",
"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-20T11:17:49.8027234+00:00"
},
"modified_dateutc": "2025-11-20T11:17:49.8027234+00:00"
},
"marketing_segment_id": "494af6de-2b33-4e42-a871-05c3180a2dec",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "012d0ec1-c4bb-4f5e-8096-d5a56cb70d61",
"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": "585661b2-999c-4f3e-b9f4-b6782536b329",
"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": "2e46e63d-f327-49a3-8cd4-52698223b793",
"db_country_code": "sample string 28",
"feelist_id": "11297b32-f462-4777-b3d0-3dd7497f16f5",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "d975b8e6-1541-4204-809c-ce36c1c7c4d9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "49f6ba27-1fbd-467d-a9cf-9c6db58f7708",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-20T11:17:49.8027234+00:00",
"db_currency_id": "f4d0c766-030a-4dea-bdc2-7afa8d67a9ce",
"db_currency_code": "sample string 10"
},
"company_type_id": "1d9074b6-25a6-4047-88d0-4e200b5fdac6",
"company_type_name": "sample string 32",
"company_type": {
"id": "210f56ab-f227-47b8-b3a9-480fc07f7971",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f2467ce9-770e-4949-a24e-6fc0859b36d7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "07c8545e-5233-42d5-b94c-e6d9f6445463",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "98d3882d-f0bf-424f-9d32-60dd28445709",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "865b9fd3-fd86-491e-ba58-f9425b2cd402",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "639964d7-18a3-4d2b-9e88-e77ea3585d67",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-20T11:17:49.8027234+00:00"
},
"company_sector_id": "9372db3a-a269-46cd-a2dc-9b26cda47f5a",
"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": "feda96a7-b2ea-4c03-8aae-dd67c6aa6a7b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "631b144f-e4e6-48eb-abdc-4e13658fcacf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c6ae9f0b-1f5c-4bca-99b4-078c45f463ea",
"account_manager_user_code": "sample string 56",
"company_status_id": "fe2dccf7-439f-41a9-9978-c603ecf67086",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-20T11:17:49.8183337+00:00",
"id2": 60
},
"db_language_id": "3a23ffbd-fa82-42d0-bd31-1be905fe9ff6",
"db_language_code": "sample string 7",
"db_title_id": "18ceb1cb-98db-4bd3-89d8-733314b44cc0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-20T11:17:49.8183337+00:00",
"create_date": "2025-11-20T11:17:49.8183337+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-20T11:17:49.8183337+00:00"
}