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": "1f319319-7b28-4ef6-8c7d-f8a760f701c0",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bfc7ce2d-2113-41ef-b63c-75226f0c8097",
"company_code": "sample string 5",
"company": {
"id": "84badcce-9897-4258-a184-510f918fa765",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-12T05:12:08.298302+00:00",
"sales_territory_id": "634569de-11c3-40b5-8986-4a56d4a4acc2",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1ccc0171-e497-477b-82c0-3727d3c140d7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5cb1950b-7076-43d7-ba7a-452999e7c0cc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8b1a4c15-a34d-4dec-9509-456d119bbaee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5813f73d-6cbf-4706-9f60-3806b514dd62",
"db_currency_id": "046c8c09-937a-4bdb-a066-f84bd9e0b2f6",
"db_language_id": "8a2a6c50-7aa7-45f9-9998-b9bbc77923c1",
"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-03-12T05:12:08.298302+00:00"
},
"modified_dateutc": "2026-03-12T05:12:08.298302+00:00"
},
"marketing_segment_id": "43732946-2089-4fc9-af61-5cadc985a0a7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b0b1b3c1-7e21-4bc1-83b1-81e8aaa6365c",
"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": "4f07f5f9-9324-4caa-a6be-4043f3a6fc76",
"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": "6050f73d-319f-47e3-af05-51d54b739578",
"db_country_code": "sample string 28",
"feelist_id": "3b3973fe-c214-4092-a4f6-e57927a4e875",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "49faa951-11ad-4383-8563-f5cc28a951bd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "af65b300-b313-4b75-a584-e6aed2b63f13",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-12T05:12:08.298302+00:00",
"db_currency_id": "9e88131e-f273-4922-8133-824315522eaf",
"db_currency_code": "sample string 10"
},
"company_type_id": "e4856594-9217-44c1-b760-48dd8c69c3a4",
"company_type_name": "sample string 32",
"company_type": {
"id": "0f17ec30-d5e1-4115-aa1f-a54d093824f4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "928498b9-f104-4f79-b276-c40a88980025",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ee269ed1-178a-4c20-a9ab-1d555d434511",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7b0b279b-abec-4e3d-b6cd-12bfc09e2902",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "634b8bd2-7a2e-41b2-a5d4-89b6f981ad22",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "72fc3b71-a039-43ec-96b2-d5b466953c04",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-12T05:12:08.298302+00:00"
},
"company_sector_id": "3c2b2ca2-a349-4dc1-a9f1-5e168ee5f5fb",
"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": "b3cb7786-2df9-420f-b65f-529862dec52b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2a00445e-d131-4792-9b4c-6a30643013e0",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "712821bb-c2b5-4a95-9a68-d4e5aabcee0c",
"account_manager_user_code": "sample string 56",
"company_status_id": "056e6713-d358-4431-a449-47e5efadccc3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-12T05:12:08.298302+00:00",
"id2": 60
},
"db_language_id": "f24dbd12-5937-4eb0-8041-1b198c3ed7b5",
"db_language_code": "sample string 7",
"db_title_id": "75b3ea25-5adf-4483-b283-4bb4c394c29b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-12T05:12:08.298302+00:00",
"create_date": "2026-03-12T05:12:08.298302+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-03-12T05:12:08.298302+00:00"
}