Retrieves all the company contact
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
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": "eab2c06f-3a97-4412-beeb-e866f2edf269", "firstname": "sample string 2", "lastname": "sample string 3", "company_id": "3a8581bd-d426-4b5b-af8c-725f7672fe55", "company_code": "sample string 5", "company": { "id": "ba986eb7-1a44-4a75-a38d-517ad6b9448a", "is_client": true, "is_supplier": true, "archived": true, "name": "sample string 5", "notes": "sample string 6", "create_date": "2025-07-18T23:42:39.9874458+00:00", "sales_territory_id": "4b0e2cf8-827d-4f42-859a-1087bdbf615c", "sales_territory_code": "sample string 9", "sales_territory": { "id": "141ca680-731b-44c2-b28a-87559cff99ad", "code": "sample string 2", "description": "sample string 3", "sales_organization_id": "86219974-7b3a-4a1f-81f3-41c9d68b6330", "sales_organization_code": "sample string 5", "sales_organization": { "id": "65de8287-79d7-4b22-9e7c-56432095637c", "code": "sample string 2", "name": "sample string 3", "description": "sample string 4", "db_country_id": "e525c011-f49f-4792-b015-907780b0e485", "db_currency_id": "10b0264b-b9eb-4684-b7cf-4b6383d6d405", "db_language_id": "d1774ffa-9833-4de5-baf9-dfa235027188", "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-18T23:42:39.9874458+00:00" }, "modified_dateutc": "2025-07-18T23:42:39.9874458+00:00" }, "marketing_segment_id": "8d3c7244-deaf-449c-9148-127b674a210b", "marketing_segment_code": "sample string 11", "sales_organization_id": "5b1daf95-4615-47eb-aa33-5c4ec0147637", "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": "1b297bc6-742f-452f-abd8-a3781658437d", "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": "169b64ec-98f9-478a-b932-66ece13909b3", "db_country_code": "sample string 28", "feelist_id": "9aeed4ee-6d84-40c1-b574-8b5ebb5d764e", "feelist_reference_back_office": "sample string 30", "feelist": { "id": "8dba5610-bf9d-4116-b778-db74a43e1051", "name": "sample string 2", "description": "sample string 3", "is_default": true, "default_price": 1.0, "sales_organization_id": "f458360f-c8c4-4094-8066-4379c1624615", "sales_organization_code": "sample string 6", "reference_back_office": "sample string 7", "modified_dateutc": "2025-07-18T23:42:39.9874458+00:00", "db_currency_id": "93ba7573-f8b3-4f6d-8223-528271e7c4fa", "db_currency_code": "sample string 10" }, "company_type_id": "bcf4e8e0-cf8a-4117-bf24-5d2928efed66", "company_type_name": "sample string 32", "company_type": { "id": "4d19086e-cb63-4ae4-8cfb-0ec69d10b371", "name": "sample string 2", "description": "sample string 3", "sales_organization_id": "e72764f8-dfb9-4e3b-b0be-ed4f907ec47d", "sales_organization_code": "sample string 5" }, "db_language_id": "5038e748-3813-45cb-86b2-74385c8168aa", "db_language_code": "sample string 34", "code": "sample string 35", "article_price_label_id": "00cc3c5d-18ac-4ab4-90d4-c3f6795f5bd0", "article_price_label_code": "sample string 37", "db_payment_method_id": "2255107b-8ce8-4f78-aee1-ea78c29f6d9a", "db_payment_method_reference_back_office": "sample string 39", "db_payment_methods": { "id": "00c64be6-cade-4c8a-8ced-b1a3fb920efb", "name": "sample string 2", "description": "sample string 3", "reference_back_office": "sample string 4", "activated": true, "modified_dateutc": "2025-07-18T23:42:39.9874458+00:00" }, "company_sector_id": "04446c2f-3155-4c35-a0d6-d71ea41bfdbc", "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": "303a7112-2d6e-44d1-9e8a-64bc050e0eee", "service_manager_user_code": "sample string 52", "finance_manager_user_id": "999a247a-2603-4730-80af-dc3686288d7e", "finance_manager_user_code": "sample string 54", "account_manager_user_id": "7385413b-8363-4f29-9a02-2ae851261181", "account_manager_user_code": "sample string 56", "company_status_id": "34d1b467-ae03-47f5-b60e-1d72e072470c", "invoice_email_to": "sample string 58", "modified_dateutc": "2025-07-18T23:42:39.9874458+00:00", "id2": 60 }, "db_language_id": "d7a542a2-60b6-4bda-a242-00dfb01ec5b0", "db_language_code": "sample string 7", "db_title_id": "f57ecca8-83f5-401d-8d53-4ac530300292", "archived": true, "functions": "sample string 10", "e_login": "sample string 11", "e_password": "sample string 12", "notes": "sample string 13", "birthdate": "2025-07-18T23:42:39.9874458+00:00", "create_date": "2025-07-18T23:42:39.9874458+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-18T23:42:39.9874458+00:00" }