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 :
contactName | 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
{ "id": "3f75cc43-b9b6-4c0a-b79a-c1586af9bb87", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "bf328601-17ce-4356-a532-6c0831d42b69", "company_code": "sample string 5", "company": { "id": "cefe957f-e34a-44ba-ba89-11a248e59562", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-10-05T10:43:57.0641014+00:00", "sales_territory_id": "b50e1fa3-0b6f-4ad9-adf2-50c2cdaad91e", "sales_territory_code": "sample string 9", "sales_territory": { "id": "5e7a3019-4df2-4316-836c-bcd7723cc874", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "60dd14d8-ca19-488c-b21d-544a9dd286b7", "sales_organization_code": "sample string 5", "sales_organization": { "id": "bfacc86a-6342-4d11-84ee-a9cb877f71a3", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "fe7b8f8c-e81a-4042-a0fd-ae8fc0ad4b9f", "db_currency_id": "7f8c11cf-3f5e-48f2-b8df-4fc62ccff21e", "db_language_id": "5b988e71-7842-4fad-ba38-a90d6ecf97ee", "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-10-05T10:43:57.0641014+00:00" }, "modified_dateutc": "2025-10-05T10:43:57.0641014+00:00" }, "marketing_segment_id": "97432999-4e36-4b77-b765-3ce8d268f66f", "marketing_segment_code": "sample string 11", "sales_organization_id": "f1f50501-a853-4121-b523-8566e55bf1d8", "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": "b36438a1-d755-4120-afa5-5a673790b589", "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": "63012b45-84ac-4fe5-8f18-2570b4980ea2", "db_country_code": "sample string 28", "feelist_id": "6f677cef-ca69-4125-ad42-6fac078a663c", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "4fb798c2-bd7d-4ced-a9ba-366360140a33", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "ecb2a8d6-e1d4-4704-a86e-3aae8ad84e5e", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-10-05T10:43:57.0641014+00:00", "db_currency_id": "9a3683ed-bcca-4e82-9084-d8032e4e53c0", "db_currency_code": "sample string 10" }, "company_type_id": "7d06a2f9-2e3e-4947-a2f2-7c15167089fe", "company_type_name": "sample string 32", "company_type": { "id": "7c2f959d-0e6e-44ef-89eb-0a93896568e3", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "e43169eb-9741-48e6-970e-bcc8271f4baa", "sales_organization_code": "sample string 5" }, "db_language_id": "13d213fa-4bde-4026-946f-9c07bc6aee19", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "d51ecb14-e68e-416d-8910-0ed37f317585", "article_price_label_code": "sample string 37", "db_payment_method_id": "92ea5495-5dba-4c92-8d5e-7a9ab0463edd", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "a70540d2-698c-411e-988a-0c59423c9013", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-10-05T10:43:57.0641014+00:00" }, "company_sector_id": "c3020924-629c-4f14-8c83-b98e69bd5303", "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": "77045338-7191-4b35-bd1e-72b3d9f669d6", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "f57bace9-566b-468d-9503-a4e37bd634c5", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "3f330f20-aafc-4267-9c6e-88226f764a80", "account_manager_user_code": "sample string 56", "company_status_id": "c24cd13d-6e65-4a86-9d0c-867bd6cbcb1d", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-10-05T10:43:57.0797239+00:00", "id2": 60 }, "db_language_id": "2fc65b97-5a9d-4546-b9fa-530e3eb6e65c", "db_language_code": "sample string 7", "db_title_id": "2f07180c-4515-409e-959c-d15bda35fbde", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-10-05T10:43:57.0797239+00:00", "create_date": "2025-10-05T10:43:57.0797239+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-10-05T10:43:57.0797239+00:00" }