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": "1e437802-802d-40c6-afb8-232b4021cc31",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "7f4daf68-8f7b-4a46-942a-a0d81c4e1521",
"company_code": "sample string 5",
"company": {
"id": "04429220-c443-4ff1-8902-5bd157e8a59f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-01T00:43:51.8268638+00:00",
"sales_territory_id": "7f321cdf-c7da-40f9-ba48-13b7e61ce381",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bfd7bab6-aae3-42ed-9df2-165a1758e01c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "229c2a40-6cad-41f3-9713-5a69930b9852",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b24b31d4-10ff-4abd-903e-9edad63b7bcc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf76c3a5-d192-489f-8881-149ea69f7715",
"db_currency_id": "c90d0a3b-398e-4d96-a4ee-0a6cf6ebb435",
"db_language_id": "456c632c-3464-49e4-914a-489d53302321",
"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-06-01T00:43:51.8268638+00:00"
},
"modified_dateutc": "2025-06-01T00:43:51.8268638+00:00"
},
"marketing_segment_id": "3bf45035-c552-439d-8e24-0f4bca0a56f7",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c6bb6dbb-8e90-498d-a7ab-22867ecebffc",
"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": "229c6a47-49d3-4a01-8990-98359fdfe6b8",
"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": "e31d52b6-e008-414d-93bb-56c3d161cfff",
"db_country_code": "sample string 28",
"feelist_id": "c238da88-6b81-475e-a1a6-b67c3c62bb2a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5c0fc837-98e7-45fe-a47e-c0d77569df7e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bf4e4ed0-5627-4ef6-b265-b6d4ecebb7a1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-01T00:43:51.8268638+00:00",
"db_currency_id": "985380b9-2f30-4433-ae20-dd73b4ec3851",
"db_currency_code": "sample string 10"
},
"company_type_id": "87978756-742d-49c1-9282-4c9726c594c6",
"company_type_name": "sample string 32",
"company_type": {
"id": "3306dbce-80d5-4bdc-b2bd-5e45bc1c5683",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d0d1647b-a5e4-4d6c-a808-02859905343d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ad175a82-a21a-459a-9d2b-33727cbd18f3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "a3e9eebd-a7c1-4549-ac1b-e6e19473150b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "44258614-ea47-48af-871a-510d347254a5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7f72d17c-ecfe-480a-8c55-e3649ce4bea6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-01T00:43:51.8268638+00:00"
},
"company_sector_id": "06dc194a-8254-448c-ad45-102bafa9f4bb",
"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": "bd26c1da-5fec-46d3-b2ea-7f6957f97d65",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "161daba0-9512-444e-8cc5-043244fd0ce9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a336f00f-54cb-4986-8341-ba9920a0ac3a",
"account_manager_user_code": "sample string 56",
"company_status_id": "f2299d9d-bb06-450b-bc8e-7251d4b63e12",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-01T00:43:51.8268638+00:00",
"id2": 60
},
"db_language_id": "481c21df-bf85-4fa6-b07b-79a42b6985f9",
"db_language_code": "sample string 7",
"db_title_id": "0481541d-84d3-4a14-bb07-87e06bb8a94b",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-01T00:43:51.8268638+00:00",
"create_date": "2025-06-01T00:43:51.8268638+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-06-01T00:43:51.8268638+00:00"
}