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": "cdb87859-65b8-475b-9876-01e23e917abe",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fae93310-0401-4640-856e-30ef53066fad",
"company_code": "sample string 5",
"company": {
"id": "f05c9888-543f-42ea-8631-d206af777ad9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-08T14:46:12.9423406+00:00",
"sales_territory_id": "37b81aa9-a629-467f-b6a4-c8eb65207917",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "be8a2cae-028b-41e3-9236-4ef8b5e2eb34",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f654dc69-264b-4810-9b04-bcd342a2e2c7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d1c6f2e8-2f9b-4d53-a074-dfcc624635c3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "877b9084-4a95-4fda-be0f-e03c3f031c1a",
"db_currency_id": "90424c82-f477-4464-93b9-65ff4cfe982b",
"db_language_id": "b0e31860-9a0f-4872-85ce-a3b1ea82959c",
"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-05-08T14:46:12.9423406+00:00"
},
"modified_dateutc": "2025-05-08T14:46:12.9423406+00:00"
},
"marketing_segment_id": "5771a96b-1e2b-4320-b3d6-29ea3ebc2a27",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "368bd537-1d03-46b8-9f8c-9040d82f1215",
"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": "7ba546c3-a664-45ee-880b-dd70c173217f",
"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": "f269ba81-7daf-4313-b2c2-e84c87475135",
"db_country_code": "sample string 28",
"feelist_id": "0582d0a8-dfc4-46ed-b49d-e970c023ec25",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cb2b6b2f-8292-459e-8228-8ddcd473ce4d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "14952412-e975-4aa9-974f-1341a677c0d9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-08T14:46:12.9423406+00:00",
"db_currency_id": "3a40144a-db7d-4806-a68b-dfe22b09fc87",
"db_currency_code": "sample string 10"
},
"company_type_id": "1c0b5b15-daf6-4124-902b-6e0b90a05277",
"company_type_name": "sample string 32",
"company_type": {
"id": "f5994000-76a2-4674-8163-a0616ae593ea",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "25631bca-f0b8-41df-9c74-e1f8778fc61c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "17523920-01ef-4bf5-ac26-22f267015993",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e45af8b3-99c5-4981-ac2e-1483ded8df35",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "163820a3-ba4d-4352-a384-7d25538469d3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "153cd3ee-d661-46ec-bee9-ac4d35769696",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-08T14:46:12.9423406+00:00"
},
"company_sector_id": "487d15c1-3728-416a-bca8-764179fa41ea",
"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": "00918274-d2f5-4c5e-be92-775173001985",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "6eb9b2d8-5d1a-47e4-8cab-2be09216311f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1e857fc0-479f-4562-a4f5-f1b1caab8ba5",
"account_manager_user_code": "sample string 56",
"company_status_id": "31ca6a48-229d-40db-beb1-6037dca52a01",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-08T14:46:12.9423406+00:00",
"id2": 60
},
"db_language_id": "365e4d64-2a19-41c8-b03c-b3eb221e11da",
"db_language_code": "sample string 7",
"db_title_id": "d23aee0f-e555-45fc-9f10-aa5ea613d3a6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-08T14:46:12.9423406+00:00",
"create_date": "2025-05-08T14:46:12.9423406+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-05-08T14:46:12.9423406+00:00"
}