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": "5f67a503-2068-4acf-91d8-9627c546c7b2", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "6ab04432-7739-43d5-b464-d61c504ec46a", "company_code": "sample string 5", "company": { "id": "0db374cb-c62b-4b87-ba93-fabacd872a0c", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-07-03T14:35:58.9435518+00:00", "sales_territory_id": "b58ab3b7-d157-4057-a521-35b55c6482d3", "sales_territory_code": "sample string 9", "sales_territory": { "id": "6a261312-4c9e-485d-9bd4-23a0329f6286", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "d3cd793d-4d20-477b-9df3-8542f09835e2", "sales_organization_code": "sample string 5", "sales_organization": { "id": "e149f54c-ba54-4dde-9a64-5b9901f51f89", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "66574925-28f4-482f-ad7c-148eb08934ca", "db_currency_id": "5aeb126c-f4d7-4bc2-b433-e5c2539b97e4", "db_language_id": "f0c3f41e-d430-48bd-852c-379b60a461b0", "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-07-03T14:35:58.9435518+00:00" }, "modified_dateutc": "2025-07-03T14:35:58.9435518+00:00" }, "marketing_segment_id": "0576bcff-8c34-4f88-ae30-bd42ffffbc4f", "marketing_segment_code": "sample string 11", "sales_organization_id": "87a14706-fab4-4979-b407-a48f487a8a1b", "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": "24b78c5c-8337-4834-a76e-dc8ef7288d11", "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": "781cfc27-91f3-40ed-9fa5-c8a1e04e63c5", "db_country_code": "sample string 28", "feelist_id": "2b37cc57-3f5b-49f7-bcfe-068106b2f88f", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "bb51ffd9-0b4f-439a-a613-8dc43fd9311a", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "275eee38-3857-40e7-83e1-3acfda29d695", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-07-03T14:35:58.9435518+00:00", "db_currency_id": "2d0029b8-2248-48de-9b25-e70afe07385a", "db_currency_code": "sample string 10" }, "company_type_id": "8720c9e8-e891-4bb5-b07f-68268f0da30b", "company_type_name": "sample string 32", "company_type": { "id": "457d5064-b22b-4e34-9f85-846d74fcc0e7", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "663ada5d-c472-4f4a-8245-e59721af3f82", "sales_organization_code": "sample string 5" }, "db_language_id": "7ea74d4f-0e4f-46ab-a65c-41365458e5f8", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "c9a534a1-d31b-4b85-9455-dcdd972c7cdf", "article_price_label_code": "sample string 37", "db_payment_method_id": "72de1db5-708d-44a6-9312-4db2cf946036", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "5fb9f18c-8aa0-4fe8-8cd2-29963d99f637", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-07-03T14:35:58.9435518+00:00" }, "company_sector_id": "98bb70e9-463a-4a16-ae67-ef359668e0e1", "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": "3d1c3fa5-ba51-4d8e-b219-62e9cba3c4b7", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "ab5b93de-c56e-44f8-84d9-413aa26b6bdc", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "9f74fcc7-2191-4ba1-81d1-2a0cb54c622d", "account_manager_user_code": "sample string 56", "company_status_id": "8e0497f6-332f-4ffd-bbd0-abd96c5086a3", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-07-03T14:35:58.9435518+00:00", "id2": 60 }, "db_language_id": "1bd60f9f-6218-49cb-877d-714f378a815f", "db_language_code": "sample string 7", "db_title_id": "77682d67-ab12-46fe-91ac-bd48efc57542", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-07-03T14:35:58.9435518+00:00", "create_date": "2025-07-03T14:35:58.9435518+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-07-03T14:35:58.9435518+00:00" }