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": "183733e0-d72d-4112-8c33-871f8a86a50a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "448bb1f8-e6f7-4303-a140-bb93940fed2d",
"company_code": "sample string 5",
"company": {
"id": "2b4d0592-58af-4310-9b5d-04f558b76228",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-23T21:56:26.4886908+00:00",
"sales_territory_id": "61a439c4-8ba1-431e-85a7-2a0773a4b57e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2648375e-5c89-46f8-92c6-199d4853465f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4680c672-0521-46fe-8096-a756c44f6def",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e6a33e0a-34a8-4b2c-ade3-8e06d1cf4d24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f943b592-e995-4941-8a7e-f9168a8f51a6",
"db_currency_id": "1ab504e2-3894-4037-988f-7904237b3a59",
"db_language_id": "d501846a-1714-4405-9844-ab28dba17d96",
"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-03-23T21:56:26.4886908+00:00"
},
"modified_dateutc": "2025-03-23T21:56:26.4886908+00:00"
},
"marketing_segment_id": "59784e06-bddb-4c6a-8438-90b7989fcabc",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8d72ffc2-0519-483f-9ea3-c471bcfef8e9",
"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": "d6e3c4b2-07b7-48ba-95d1-55d441f9034d",
"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": "66613816-fb95-4e02-b5ee-49934f1e69a6",
"db_country_code": "sample string 28",
"feelist_id": "a309af60-f8c3-4954-af25-9ecfb6a2cfdb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "70815b91-b684-49af-90e0-55a4dd7769af",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "84db3649-7524-42da-83a5-55af4ab7881e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-23T21:56:26.4886908+00:00",
"db_currency_id": "aa933aa9-186b-4a82-b6ad-12ee9e384b28",
"db_currency_code": "sample string 10"
},
"company_type_id": "6a0a6287-85fc-4f3a-9f36-199fbd5e04f0",
"company_type_name": "sample string 32",
"company_type": {
"id": "84590d4a-8885-4d56-af8c-6c995840d80b",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c36d3778-a423-4ad0-a76d-479543b31a0b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4eace76c-fb16-4d64-8723-932d30e9b46a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6d221e69-a10e-4c9c-8b23-837b41b12ea3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c1bf866c-a0b3-4272-8cab-b9f2dbb2f4b9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d684c288-39f7-418d-9035-dac5a5e3364e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-23T21:56:26.4886908+00:00"
},
"company_sector_id": "f51311df-fe6a-4f19-a65f-68ee004b22fc",
"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": "58b994a4-3dd2-478f-b94b-0fe535906978",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "26eb78e5-5679-47f2-b4ec-b88525ab8da5",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "32b39b39-eaac-4da8-b0c2-9a95754cfc69",
"account_manager_user_code": "sample string 56",
"company_status_id": "e9e6aaab-df87-423b-a99e-e76b27b96789",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-23T21:56:26.4886908+00:00",
"id2": 60
},
"db_language_id": "f96e8d65-d693-4c9d-8175-1b9081faeb2b",
"db_language_code": "sample string 7",
"db_title_id": "5c60a439-ff67-452c-8d5f-6578ab27178e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-23T21:56:26.4886908+00:00",
"create_date": "2025-03-23T21:56:26.4886908+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-03-23T21:56:26.4886908+00:00"
}