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": "47615890-bd76-4d39-8558-cb99677dade3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b96718fd-0a4f-443d-a5d4-2edbaf359230",
"company_code": "sample string 5",
"company": {
"id": "74cafc28-053c-4c73-af6b-5a62e625deb7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-03T08:33:30.74977+00:00",
"sales_territory_id": "c3987fa1-be4a-457c-8e55-3a8913f9fc5e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "586011dc-1196-42e3-87c4-d32f2f164c38",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "af119c13-6bbf-453b-8af8-44111d3fae22",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7feb5b73-7414-487a-987a-4093390e2ede",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38ce0a17-5f3f-4061-8aa4-9b92f99ee14e",
"db_currency_id": "ae351f27-c874-4324-a697-6e9a691b3bfc",
"db_language_id": "b391e925-5753-4d85-8a57-dafa8e4ef8a7",
"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-06-03T08:33:30.74977+00:00"
},
"modified_dateutc": "2025-06-03T08:33:30.74977+00:00"
},
"marketing_segment_id": "292439b4-7396-4de9-818f-bc76ca501920",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "224a95a7-c2e2-43d7-8d10-666983f376d4",
"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": "338d0870-8e1f-463d-89ca-f935b1bcbab5",
"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": "e82ef074-5b2d-4d22-8205-c51aebef3128",
"db_country_code": "sample string 28",
"feelist_id": "c39dce8a-fa98-4c0d-8dab-c29150f3fc44",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "67c66a8b-ca5f-4c00-85bf-76dec35cbdb7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "0eda5712-be5a-4a2b-a216-e61cc804d255",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-03T08:33:30.74977+00:00",
"db_currency_id": "caa4a19c-03d0-4e87-a872-aa1f33713719",
"db_currency_code": "sample string 10"
},
"company_type_id": "2e96f22e-6eeb-4cbd-9dca-735b9e3ebf02",
"company_type_name": "sample string 32",
"company_type": {
"id": "cfb82cfd-65b0-45a7-bed7-f4dfda385f3b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9103d6b1-4177-47aa-b69e-c6e3692fc2d1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1eee09bd-4702-445d-ac33-a0eaee701e18",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "aca167e1-c394-4f1c-99e2-837b881bb591",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "18b288a7-6c27-45cb-95e2-4acceb99b976",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "81b92184-ae67-4dd9-8e81-8637b8772fbf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-03T08:33:30.74977+00:00"
},
"company_sector_id": "0bbe6377-2c92-4be8-b264-c90db9720fd0",
"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": "a913a649-b520-47f3-9539-b4b850dcee3e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6ca6e253-cc3d-48d7-900e-9db23010444d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "40de494e-305d-4dc9-ad0d-525b80823946",
"account_manager_user_code": "sample string 56",
"company_status_id": "5f6bdf91-8dc8-4a6b-8155-826e8eee3584",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-03T08:33:30.74977+00:00",
"id2": 60
},
"db_language_id": "b4ec24d6-b730-4b08-83df-620ba96cf186",
"db_language_code": "sample string 7",
"db_title_id": "66e8f3d8-92ec-45fe-91b3-4ab1d4396c56",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-03T08:33:30.74977+00:00",
"create_date": "2025-06-03T08:33:30.74977+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-06-03T08:33:30.74977+00:00"
}