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": "f52411d2-4d99-4d0c-b003-2980fe3456d1",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eafec238-a55c-492f-8f82-69d2c2969a77",
"company_code": "sample string 5",
"company": {
"id": "20a99a15-7876-4eaa-9f4c-bb1605e0b3ef",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-14T14:46:58.4079067+00:00",
"sales_territory_id": "513fa9f1-d182-4695-860c-71edf8a53758",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "267fff15-87fc-451f-b60e-b56980474273",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c66d7a06-150f-425a-a5cd-3295f6d6438c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f6b64288-5b3d-4f18-b2ee-af2d65a88c63",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "80310541-1c88-4dc0-9a18-29e66a6a8250",
"db_currency_id": "ee1ae1ec-1304-4ded-829b-dd4e2941687b",
"db_language_id": "8310dda4-e6f3-4612-833c-2c60fa60c23c",
"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-02-14T14:46:58.4079067+00:00"
},
"modified_dateutc": "2026-02-14T14:46:58.4079067+00:00"
},
"marketing_segment_id": "799733fc-9d22-4b17-b1cd-b780bf62c0d2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "008e367a-3400-4309-afea-8202664bcf29",
"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": "32039077-4228-45ff-b987-e8c558091f7c",
"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": "5b0dca37-e16e-423a-abf6-23e0032180d7",
"db_country_code": "sample string 28",
"feelist_id": "e54c14c0-e0ba-4e88-8798-5847c07d2ef6",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "23b76235-3e9c-4905-93e4-5265fdf14378",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "7b3d8080-be95-40c8-bee7-c1c6c54249f4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-14T14:46:58.4079067+00:00",
"db_currency_id": "3e674fe4-534d-495d-aec0-138ee3f6587a",
"db_currency_code": "sample string 10"
},
"company_type_id": "c2c7fa89-292d-455f-8518-6c85b6c2097f",
"company_type_name": "sample string 32",
"company_type": {
"id": "3d08aed7-5ff6-4bc0-a9f5-3b4c8c0cf42f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "b0b881fd-d8e5-4bf7-8899-d709a5fdca92",
"sales_organization_code": "sample string 5"
},
"db_language_id": "475080c3-7dbb-4ddb-9f11-b88e474e8f34",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6b042135-9ea2-4c72-b6ec-6de84882177a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "cc97b338-4c0b-4691-bc9c-6415ec87f1c7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4d42342e-218a-4f56-9258-60cebd3d63d1",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-14T14:46:58.4079067+00:00"
},
"company_sector_id": "5d111bb6-a467-4fe3-b2ff-f72e737b11ab",
"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": "811c7f4a-c7bf-4e1a-b59a-39f3b8abb143",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "ace02154-f3d9-45e1-a012-319b2fe3f3eb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a7797b10-68b9-47db-aa87-999c81027772",
"account_manager_user_code": "sample string 56",
"company_status_id": "9c3b049f-bd97-4e68-b7ac-496d18e4bdf3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-14T14:46:58.4079067+00:00",
"id2": 60
},
"db_language_id": "eb12dee9-d404-4010-bbb5-c41b776814c9",
"db_language_code": "sample string 7",
"db_title_id": "5011425e-42b9-46e8-94b7-88f5b8914806",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-14T14:46:58.4079067+00:00",
"create_date": "2026-02-14T14:46:58.4079067+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-02-14T14:46:58.4079067+00:00"
}