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": "3e59e4b0-3611-4209-8582-831660b8dea6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "953ba814-52ac-49c3-a48f-a12095ddceaf",
"company_code": "sample string 5",
"company": {
"id": "ef59584f-fb75-483b-b1b5-7c9b63d21f39",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-18T16:40:11.5321171+00:00",
"sales_territory_id": "b2a1c0f4-1180-4ea4-9992-49ec9912c03a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d183da1d-4766-42e3-9c06-46cff6d45c5e",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "725995d6-adc9-444b-b5f7-8af02d2054df",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2b0b5a8b-adc3-4117-b67b-cec280fdfde3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e537dd8e-5aea-4213-bfdb-b14f7e884474",
"db_currency_id": "921a470a-0e6d-459a-b746-92c5d9d05efa",
"db_language_id": "9b119a4c-42b3-435e-9f22-bbcd9121cea0",
"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": "2026-06-18T16:40:11.5321171+00:00"
},
"modified_dateutc": "2026-06-18T16:40:11.5321171+00:00"
},
"marketing_segment_id": "0029b8e3-e31d-4ed2-a07f-ac76d38489ba",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "080bf073-df80-4a4c-aa68-d7dbbcc10dba",
"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": "8ecd64d9-c8bc-4697-9dbd-739664a39d27",
"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": "5c73c75f-50cd-463a-94e6-371fe8b93db5",
"db_country_code": "sample string 28",
"feelist_id": "2222a0b0-e7be-49bb-a09e-cc40673f3896",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "179cb208-3efe-43bd-9491-462fa7b19385",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "ae051f9e-2eb1-4e52-9dca-b14813e55938",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-18T16:40:11.5321171+00:00",
"db_currency_id": "c5ebb262-98fe-48e5-9129-d15851f09c98",
"db_currency_code": "sample string 10"
},
"company_type_id": "2e80a543-ba2f-4cc2-96e1-bf619b0b2de1",
"company_type_name": "sample string 32",
"company_type": {
"id": "bab3bd63-a271-41cd-abd9-14d94109c5d3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9fa77463-4b66-44d2-8c52-2cfa75611c44",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e87fdd0b-f8c5-4d5f-8327-5a13e55e4d08",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "d03bc094-8897-4092-94f9-78855547b95b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b8d675be-42c9-4beb-8379-be9d7571129d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ff349288-3044-4274-bbe0-ad37af4c04ab",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-18T16:40:11.5321171+00:00"
},
"company_sector_id": "e532fbe8-0985-47ff-a74e-e66eca776fca",
"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": "fef43121-806a-4eb3-9ada-bba925eea7dd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "132378bf-6bb2-4b42-9a4f-8845a6a57d31",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8b66b3d0-923d-4376-9cb9-58a9476bdf9a",
"account_manager_user_code": "sample string 56",
"company_status_id": "62f442e5-8cc9-45e3-be13-af59f0d2563d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-18T16:40:11.5477438+00:00",
"id2": 60
},
"db_language_id": "39dce313-47fa-4b26-9b41-2b461ba96665",
"db_language_code": "sample string 7",
"db_title_id": "4f37168f-288d-4c6a-94cc-32b5f1fa5128",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-18T16:40:11.5477438+00:00",
"create_date": "2026-06-18T16:40:11.5477438+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": "2026-06-18T16:40:11.5477438+00:00"
}