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": "33d8b409-4639-4890-a853-343e89c7a334",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "d20216e5-091a-49f9-b2ba-3c863720e052",
"company_code": "sample string 5",
"company": {
"id": "d3d98f05-9c2c-466b-ade3-5a569055a583",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-16T16:50:23.4124541+00:00",
"sales_territory_id": "32bbdb11-4785-4d2c-bc47-e6b638671c05",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "95d56d8d-cb34-485d-902f-edebd20d17d9",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5c9a369f-76e1-40a6-9164-e2a354c6bea4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c2ce12b8-aeff-4d7d-b3b5-25dfb417f72e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b40194e-6797-4d8d-b817-76f9b621832a",
"db_currency_id": "43a635bc-a286-4086-95c3-7f43b89879a6",
"db_language_id": "4bac977b-b94c-4b1c-a7e7-e2823a830d6c",
"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-16T16:50:23.4124541+00:00"
},
"modified_dateutc": "2025-05-16T16:50:23.4124541+00:00"
},
"marketing_segment_id": "b3ee57a7-4eac-423a-83a6-911a2ecdfaa3",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7c4aa63f-6cae-46fb-bf23-e66f41b20248",
"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": "639fa90c-4966-4447-b34c-235f8750b8cc",
"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": "7a2a29a7-74f8-41ad-bc68-e6f9f7a74b5c",
"db_country_code": "sample string 28",
"feelist_id": "28404b7e-085b-44a8-b5f7-114497081e92",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "75566e04-0cb4-449e-be5f-e172ff275416",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2afccdf8-23fa-4650-8ae9-c5b26e6efe39",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-16T16:50:23.4124541+00:00",
"db_currency_id": "c505d26a-3fc1-46b3-ad1f-10a0246e89fc",
"db_currency_code": "sample string 10"
},
"company_type_id": "9127a9b1-ebb2-4398-860d-abe8c39b98e9",
"company_type_name": "sample string 32",
"company_type": {
"id": "09ac2781-e8e4-471b-be6e-dde3efac47bd",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a41bb19a-70c8-4bc5-a994-409f41ee2c4e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a4ee8ba5-c04d-44c5-9c7c-fb1b4a1895b5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3fbfeac6-a03f-4bd7-92d1-7e6814bbedb8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "06538b34-3242-4127-96e5-0961776f39cf",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "250e29de-5903-473b-9738-d2cdb75f0ff6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-16T16:50:23.4124541+00:00"
},
"company_sector_id": "92a07d74-f9c2-4632-af9f-c9c01527fab2",
"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": "56e7f9b8-a4a2-4e37-aabd-d17bc921f905",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a7db4123-af7c-47a1-84a9-ea3d20ba5bea",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "742069d4-46db-4499-a610-7952f845fc05",
"account_manager_user_code": "sample string 56",
"company_status_id": "b32b6fa8-46a7-4cfa-b054-fa4b05cbb6e4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-16T16:50:23.4124541+00:00",
"id2": 60
},
"db_language_id": "c80d3b41-4432-4c0c-978e-e799bf68d437",
"db_language_code": "sample string 7",
"db_title_id": "1241d969-4340-4cfb-baa0-f9d83948e154",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-16T16:50:23.4124541+00:00",
"create_date": "2025-05-16T16:50:23.4124541+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-16T16:50:23.4124541+00:00"
}