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": "3df719db-efd4-43a4-813e-b7f4a323607a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cb02ecdb-c089-4d23-a14a-c751a59c5a74",
"company_code": "sample string 5",
"company": {
"id": "8906e082-42dd-44c9-b23a-93809f01b018",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-18T14:54:13.6673074+00:00",
"sales_territory_id": "f1224d5c-94b3-4fa0-8776-eb679de9f3c0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "282e5580-2eaa-4bc0-9d0d-2f3604111448",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c4d258e0-672a-47d0-8922-3359a65221af",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1968db12-de6b-48d9-b80f-e10407934ff0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49a234f5-e343-4171-b04e-0edb43d28b58",
"db_currency_id": "bdc484b3-a263-4fe9-ac44-8e5c3612f05b",
"db_language_id": "117c2768-0a79-4fa6-881a-e7872781a886",
"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-09-18T14:54:13.6673074+00:00"
},
"modified_dateutc": "2025-09-18T14:54:13.6673074+00:00"
},
"marketing_segment_id": "668bbd86-a163-41db-9f3b-6998993e38a5",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7444bc29-cda1-4a0d-81bc-3de6cffd8694",
"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": "15c0a72f-2174-4fa0-ae12-67a729cfa777",
"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": "b28ea4c0-096f-42ce-933d-2315623890a5",
"db_country_code": "sample string 28",
"feelist_id": "962e2f27-6db2-480f-b642-f5bc7fbdfebb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "cff35e54-c34d-4278-9897-52cbb90266de",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fb685b36-59d3-4a57-bb1b-0d11e38c9151",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-18T14:54:13.6673074+00:00",
"db_currency_id": "361910b2-3771-4ef6-a46a-b4771a66a935",
"db_currency_code": "sample string 10"
},
"company_type_id": "bea2dbe3-0a08-4be1-a34b-f07b7c8eca4f",
"company_type_name": "sample string 32",
"company_type": {
"id": "ed2734c9-3519-43bf-9b84-dad388ff93e4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2e1feaea-ddc7-4d7f-a94b-79f9158b2ad7",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1e128316-6ba4-49cf-9a00-b088f2661ecb",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9b582edb-3224-4633-8163-832f464d3f10",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c1034e31-92b2-4de3-9ba9-2848a0a7291d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "1c44e510-6ae4-41f9-a565-c18317e449f9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-18T14:54:13.6673074+00:00"
},
"company_sector_id": "de602597-00f7-495b-9446-1e21cc6e4b1f",
"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": "ad066e5c-2461-496b-8e19-583872010de6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ca914102-3b0e-442b-9358-eac3c59293f6",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0091b2fa-7ec0-4588-9d7c-46087376d0e4",
"account_manager_user_code": "sample string 56",
"company_status_id": "f25ee9db-bcd9-4de4-b36e-395b1ebe7e2a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-18T14:54:13.6673074+00:00",
"id2": 60
},
"db_language_id": "e821c6ab-a1f4-4cff-94c3-da2ddacf8d84",
"db_language_code": "sample string 7",
"db_title_id": "39f1a964-bf9b-4731-aa77-35486d96f891",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-18T14:54:13.6673074+00:00",
"create_date": "2025-09-18T14:54:13.6673074+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-09-18T14:54:13.6673074+00:00"
}