Retrieves all the company contact
Request Information
URI Parameters :
None.
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
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": "a692c291-73b7-4102-bf8f-0aac94d83949",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8ebca294-9675-4e17-90fe-677eeba75367",
"company_code": "sample string 5",
"company": {
"id": "37346450-c35c-4c6d-af3b-7e58bacbb3f1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-12T10:12:50.1730955+00:00",
"sales_territory_id": "cecc447e-ac3d-4200-8681-714f41c6ffe7",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "7d029023-5d2c-4461-9f4b-c46d1cf15445",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "9a589237-2606-479f-a330-5a2cb56322ab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e13823c3-ea66-4b10-89aa-b8ce156eb875",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a7e69e4b-1c40-4a11-9496-7e252b4e3332",
"db_currency_id": "43ec2060-aebc-4292-b96b-5bce5e25eb37",
"db_language_id": "63d406da-f9b1-42b8-9208-c34f770757c6",
"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": "2026-03-12T10:12:50.1730955+00:00"
},
"modified_dateutc": "2026-03-12T10:12:50.1730955+00:00"
},
"marketing_segment_id": "7e90e496-4156-4fd5-845a-6c657e7f4b2d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "26a7f932-2dbb-42f8-bc59-8b358df8ee13",
"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": "737ac2e4-6554-4445-b8ca-458f7880fc25",
"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": "0d642dc4-9e7b-4884-90f3-ba62714609d9",
"db_country_code": "sample string 28",
"feelist_id": "6d0158a0-8705-4238-8ad7-f470bb437b33",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "914aa969-c8b8-4185-a3e4-288505f07768",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "83ad54fa-1b92-424c-9f53-7efd12864ced",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-12T10:12:50.1730955+00:00",
"db_currency_id": "1d8f596c-44a3-47e0-b88b-4424f6e23155",
"db_currency_code": "sample string 10"
},
"company_type_id": "7008fb3d-86b6-4f60-90b7-9e5e50ad50ae",
"company_type_name": "sample string 32",
"company_type": {
"id": "6bc967d8-1c74-4666-95c8-99e38b9cfe70",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "993cf91a-ffbf-4d28-849a-39cd9a7c252d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2e87dddf-63f1-47a1-a19d-53389f470119",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b286df64-4e81-4f91-85e1-d3c6d32f5c6f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6ed2b0e3-6ee8-4d59-97b0-a97a9241082e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7ff917f6-711a-4fea-a8b2-89b6fef20cb4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-12T10:12:50.1887242+00:00"
},
"company_sector_id": "66b44d54-a12c-4e9e-ab37-1b97f69e77b8",
"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": "184a8e94-6305-4ed7-b773-760532326863",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "32240608-8035-4383-a1b4-96295a7a8ccd",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "024ade94-d682-4544-86da-2a3d6072ece4",
"account_manager_user_code": "sample string 56",
"company_status_id": "48380c56-a05d-4082-a8c1-f5338eba5fa4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-12T10:12:50.1887242+00:00",
"id2": 60
},
"db_language_id": "4d348b9f-b1b8-4487-ade0-61f9fb2c13e9",
"db_language_code": "sample string 7",
"db_title_id": "cb1c2e7c-d2ab-4bf7-9d92-ba9ff4cd3404",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-12T10:12:50.1887242+00:00",
"create_date": "2026-03-12T10:12:50.1887242+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": "2026-03-12T10:12:50.1887242+00:00"
}