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": "41145000-81ab-4925-ad73-077dc6e0eb1c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "223eaced-4325-4f77-9e6d-ae171c7e6c1d",
"company_code": "sample string 5",
"company": {
"id": "cd37cd02-8173-4062-8e14-dbb45ba4da51",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-03T21:35:02.4799698+00:00",
"sales_territory_id": "c27a392d-d190-4049-b56f-09b5bec05cec",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "422402bb-520f-4a9a-b9d9-5e70f5462313",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "97a17f4f-0154-4784-8838-a98668cffa51",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "77d9bb85-f530-4f0b-9113-6e71277edbec",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f50616e6-9251-449f-ae60-60b98b77c82c",
"db_currency_id": "5c457f0a-dda4-4659-86e2-c142d686a56e",
"db_language_id": "13d5bce6-ffd0-42a9-916b-4f6e845cfa6b",
"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-03T21:35:02.4955932+00:00"
},
"modified_dateutc": "2025-11-03T21:35:02.4955932+00:00"
},
"marketing_segment_id": "029976e6-d28b-4c38-9bf9-7c1d3c4c36d6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a120e7d5-6fba-4c11-a29f-c4f63496ea18",
"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": "31a323cf-6e6b-436e-8938-1103d3d596da",
"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": "e1355146-4512-454f-a806-8b0b18f6b401",
"db_country_code": "sample string 28",
"feelist_id": "623497d8-300c-452f-ba3f-d2a42ffbe166",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "6ae78b88-353c-4b11-89f6-40033e128371",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7fc282d2-6ba1-4180-a415-403bfdc01e3f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-03T21:35:02.4955932+00:00",
"db_currency_id": "e20047ff-f3ee-484a-ba0b-ed31afe23b64",
"db_currency_code": "sample string 10"
},
"company_type_id": "2a238155-8384-4b0a-9f39-1f9d1117622e",
"company_type_name": "sample string 32",
"company_type": {
"id": "d035da48-9acb-4090-8537-701181813924",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "eb36d852-6081-4132-92b9-d2368956783a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1b0ce0d4-b12a-4292-80da-ba0399d9c15c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "20f1b516-72f0-4046-bbbb-3a24ef9a5807",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "66583550-6b08-4964-ab9c-d828d3cf69b7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "efaf50c2-baa6-4678-acfd-b78ae0651362",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-03T21:35:02.4955932+00:00"
},
"company_sector_id": "8df391fa-ea09-4a48-b96f-65969df5800a",
"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": "ee719b3e-32e3-4ae6-a5c3-0b1ea0c18f35",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "d7071b42-5c25-412d-bf8d-c448351f749b",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "41b22106-abcd-48d5-86ec-f9f38032363c",
"account_manager_user_code": "sample string 56",
"company_status_id": "b1bc839e-1e00-4382-91d1-b9d1764497a3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-03T21:35:02.4955932+00:00",
"id2": 60
},
"db_language_id": "deea5cef-fe06-40d5-a60e-fc72cae12e13",
"db_language_code": "sample string 7",
"db_title_id": "8d553fa9-9178-4e0a-b004-4aa43ff8de9e",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-03T21:35:02.4955932+00:00",
"create_date": "2025-11-03T21:35:02.4955932+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-03T21:35:02.4955932+00:00"
}