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": "6375e9e4-f859-447f-afc7-f9133a9f9ad4",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "32121d39-33fc-4a73-8cd1-42beacacc0d1",
"company_code": "sample string 5",
"company": {
"id": "1b1e9e80-c437-4d5c-a5aa-95a6af72b388",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-03T03:41:18.156123+00:00",
"sales_territory_id": "3c7866b9-8ef4-49d0-b9bb-8c9a63651bf1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "87b7ea2e-c046-4159-9eeb-65f33230ee51",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c8850adc-8231-4a26-aee3-702b24fd03b0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "584b7306-3657-49e5-b0e9-840bcf249343",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c391f78e-4d11-400a-862a-8c182ef16cd9",
"db_currency_id": "459836df-ff16-4158-ac7d-1bd2231ec53b",
"db_language_id": "b8871139-92d2-4e30-baad-2aabfb229558",
"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-12-03T03:41:18.156123+00:00"
},
"modified_dateutc": "2025-12-03T03:41:18.156123+00:00"
},
"marketing_segment_id": "be775a3e-7c2d-4a34-b17c-c83fbe3e9b1f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f499c502-63ac-423b-8648-7b5583e14199",
"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": "1c619a67-4edc-441b-9fd9-50dda5f216f1",
"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": "2bd3ac66-479c-42f5-9042-6b1e790cd3af",
"db_country_code": "sample string 28",
"feelist_id": "157bd544-f5d4-427e-91df-5ced6854d6dd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a9441049-2365-4861-b9ed-6bc221540cde",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7f13c9e7-9728-468f-8221-29d4bb59ce32",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-03T03:41:18.156123+00:00",
"db_currency_id": "8f487570-795d-46a6-aa85-3a849a31707e",
"db_currency_code": "sample string 10"
},
"company_type_id": "a9098568-3a4b-4a13-a57a-69d1c44aea09",
"company_type_name": "sample string 32",
"company_type": {
"id": "bcf54256-1bde-438d-804f-b08d01cdf196",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c585d3dd-f317-4bf9-9524-f7c166e20090",
"sales_organization_code": "sample string 5"
},
"db_language_id": "06b36df0-a5ed-47f4-a5f4-272a04bce985",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8149d83c-edc0-4501-8c43-4f76643c2caf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6f60eb8d-55a4-4918-a708-7ef1aaf55984",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e22f2aa9-5d30-47da-b1d7-6a62f493b262",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-03T03:41:18.156123+00:00"
},
"company_sector_id": "f70e3b6e-521a-4590-90ae-02bf57b46d82",
"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": "852de2a4-001c-4e13-83e8-1b588afb4f57",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0b992e9b-d00c-4f86-bbcc-37dba0c42b85",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "eb753f09-ca72-4391-b003-7c9b856817cf",
"account_manager_user_code": "sample string 56",
"company_status_id": "ec444e20-032b-4974-97e8-ea17ebcb5939",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-03T03:41:18.156123+00:00",
"id2": 60
},
"db_language_id": "ccc5a838-a250-4fcd-9e56-597f400145c4",
"db_language_code": "sample string 7",
"db_title_id": "c7bf9c32-e594-4bd9-b00d-67f164fd4801",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-03T03:41:18.156123+00:00",
"create_date": "2025-12-03T03:41:18.156123+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-12-03T03:41:18.156123+00:00"
}