Retrieves all the contacts
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": "0eaa459e-e758-4ed5-babf-3828fa207c89",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4fc34313-ed2c-4e9b-b228-57b18281fa27",
"company_code": "sample string 5",
"company": {
"id": "ab6d35e3-a2ee-416b-9fac-3f55a68941c9",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-06T16:47:32.335872+00:00",
"sales_territory_id": "e1e5d58a-fbac-45f6-8f39-a6ca838fe34d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "4f22fcf0-8e0b-4d03-ab18-de66308ac4c8",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4e7f4bb0-987a-40ec-8264-4c7cbc61ce06",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d8b831d9-0adb-4692-b630-75a1be14a054",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81ce60a3-3334-4139-a7bc-13fb91c349eb",
"db_currency_id": "f36fc31c-b6be-4c17-9a1c-da12abc06215",
"db_language_id": "f8fb2026-7a63-407a-9d0e-ef55634b4b2a",
"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-06T16:47:32.335872+00:00"
},
"modified_dateutc": "2026-02-06T16:47:32.335872+00:00"
},
"marketing_segment_id": "d748d3fa-4654-4742-86a0-3ebeed2c0168",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "88c1b3d8-7cd7-430d-92f9-a9f0994f3c1f",
"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": "d6816997-8ac2-4b91-8324-556ffa68e39c",
"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": "749fe942-c7e8-40bc-9df5-070c1d7fe87b",
"db_country_code": "sample string 28",
"feelist_id": "983e0368-03f3-4702-88e4-564c18328c25",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f56b5ebd-2098-4426-afe6-329ba9cb7811",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "2de50214-0fc7-4293-a693-df11bd79ff47",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-06T16:47:32.335872+00:00",
"db_currency_id": "a93a9a6a-5c40-4311-a175-c0810a16706e",
"db_currency_code": "sample string 10"
},
"company_type_id": "7098dfd8-4d90-4c8a-b1aa-2b90166e4caa",
"company_type_name": "sample string 32",
"company_type": {
"id": "22947202-c613-4c3a-96cd-98ff091e3303",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7a7f0938-ed61-4c06-b2cf-8a69be999f21",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8036efac-57b2-4c46-af0d-4fe9ee6671c2",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "8473ce74-866f-40b8-b487-d8699f4ac8d1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ff1dd6c7-323b-4513-84fe-a6a6c765d669",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "21b7cecb-a3b3-45a8-98c6-14ef172a4507",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-06T16:47:32.335872+00:00"
},
"company_sector_id": "6efce78c-6552-4e7c-a2b3-eb7617b907d4",
"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": "47676dd6-4fdf-4f02-870c-56996fa610a2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "222fc744-3991-4b5c-bf15-624856b22080",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8e5d26f2-eb37-4379-944e-468cb9ee9a94",
"account_manager_user_code": "sample string 56",
"company_status_id": "b5b7e39e-e6cb-4246-af39-d6f2b7287619",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-06T16:47:32.335872+00:00",
"id2": 60
},
"db_language_id": "13cb6e39-1d6d-468f-8928-58db6d99ee39",
"db_language_code": "sample string 7",
"db_title_id": "2b91fe96-0f68-4a42-b07b-e84abdd9cbb7",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-06T16:47:32.335872+00:00",
"create_date": "2026-02-06T16:47:32.335872+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-06T16:47:32.335872+00:00"
}