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": "dc3b4807-7f08-4f88-9464-5958a639e7d7",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6c650aa3-253d-4524-8947-96500760fd29",
"company_code": "sample string 5",
"company": {
"id": "768ec066-09d8-4169-b18f-312d4c40170a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-27T14:23:32.441206+00:00",
"sales_territory_id": "689cbfc9-575b-4eda-8906-c5dfb838f1eb",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ae9066be-a59e-4eb4-9169-1c5013f39a35",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "303621bb-e79f-445e-8481-f5f6eabbd388",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f7b7d1de-1b83-4748-9d29-945d1c83a271",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f08b7315-9f1a-44d4-a58d-776039be82e6",
"db_currency_id": "bd1aa922-683e-4359-ab80-63eb9391306c",
"db_language_id": "efc85a92-8d3d-4cbe-a1d8-f240532f7737",
"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-11-27T14:23:32.441206+00:00"
},
"modified_dateutc": "2025-11-27T14:23:32.441206+00:00"
},
"marketing_segment_id": "c2c9f3ec-b9fb-49fe-81db-590b8b9caa95",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3e2ef013-d809-4558-9017-5d9b02c7cfec",
"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": "f76cb6b1-7449-4b65-bd85-7801075d5045",
"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": "fd7fefe9-9c04-4737-9806-78df152cb014",
"db_country_code": "sample string 28",
"feelist_id": "2620ce3e-c5d6-49d0-ba4e-46e91f71ec7e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "2269ee20-0bb5-48c1-9dca-f0d980cdc261",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5c0da099-693a-41de-9176-7a7561779694",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-27T14:23:32.441206+00:00",
"db_currency_id": "209eb6d3-bee4-4fd0-a343-d5a35c3b3a8f",
"db_currency_code": "sample string 10"
},
"company_type_id": "355afefc-3fc8-4a3b-86c7-d4af5a2edc67",
"company_type_name": "sample string 32",
"company_type": {
"id": "8ba1937b-2881-4b99-b41d-8891496de79e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "73413e84-fdcf-437b-b1a4-1b096efcf0b2",
"sales_organization_code": "sample string 5"
},
"db_language_id": "eaaeaded-0aa8-4b12-b017-88b6440bcf1b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ed45f766-d773-41d1-894e-7c8168325b0b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "707e2c97-5a63-4367-982b-f97f60afebd4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "ad4a6b82-e0f7-4306-a54b-c8cde1b9d4f5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-27T14:23:32.441206+00:00"
},
"company_sector_id": "192d34a6-78a0-4597-8ff6-9b9e51e809fe",
"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": "6f869326-b3e5-4a42-be94-6fe1070843dc",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "62c2bffa-ffbc-43dc-953b-5ff3dcf5cae3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "f441af35-200e-49d8-bed9-e0805191fef5",
"account_manager_user_code": "sample string 56",
"company_status_id": "c286165c-3fa6-4132-82fd-faea430166ef",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-27T14:23:32.441206+00:00",
"id2": 60
},
"db_language_id": "89f0ba1c-d2a3-4be8-a725-703c7646e8fa",
"db_language_code": "sample string 7",
"db_title_id": "55557c76-f341-4b7e-b4c1-f7b236055f48",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-27T14:23:32.441206+00:00",
"create_date": "2025-11-27T14:23:32.441206+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-11-27T14:23:32.441206+00:00"
}