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": "3d027e4e-a0b1-4eed-a826-c36fe75c4c7a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8b599fa7-ddbe-49a2-ae89-998008addb3b",
"company_code": "sample string 5",
"company": {
"id": "1a3fe9b0-e962-4ccd-8486-1023e09c76cc",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-07T20:59:50.4041145+00:00",
"sales_territory_id": "f4cf9b64-78c9-4a4b-8cce-1cd9fb2faf27",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5cd45c1d-a697-4d96-9110-fe5d12d6b367",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "af12abe9-e713-4984-9c5f-1c0c431a9f19",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "267e2e1b-e63b-49f4-a776-e9ccead55d93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b5fdb4ae-9a6f-44a1-baa0-2320e34eb4d1",
"db_currency_id": "2cdce032-fa10-4c9b-bf31-14a973bfef58",
"db_language_id": "0b690373-4ac2-4e89-85a2-0c31fbf9842c",
"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-05-07T20:59:50.4041145+00:00"
},
"modified_dateutc": "2026-05-07T20:59:50.4041145+00:00"
},
"marketing_segment_id": "c4119eef-91a6-40a0-9303-d2009ec7f378",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "da7e8a27-c798-4124-9b4a-2df5147e74de",
"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": "1330df6a-09d6-4007-a278-74150813c2c0",
"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": "cc5560f0-15b2-4985-8bf4-6a5a4e075b54",
"db_country_code": "sample string 28",
"feelist_id": "528f7c8b-e7fb-40df-9a6f-c34a7f033ca9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "662c0702-c776-4629-9b72-7d903e704906",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "298425b2-d182-4624-bbef-21df3dc51bdd",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-07T20:59:50.4041145+00:00",
"db_currency_id": "2dc01034-9ca6-4871-895f-3d2da2e513c2",
"db_currency_code": "sample string 10"
},
"company_type_id": "b062a6ea-ac2d-4eee-9a02-4fc2ee55dbb9",
"company_type_name": "sample string 32",
"company_type": {
"id": "65b1c7a0-9d30-4e9a-b0f8-0c8fc93ab599",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "059a48f5-2c70-436f-9b83-5f1dd1964b3f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5ea5abfd-f673-4959-931f-54c288e9d8ff",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4ee802ca-0c6c-42b7-8896-b75204acec7c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "ce9d7051-7e3c-4834-a4a1-258a5b950300",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3856641f-2625-4f28-8c67-19989270754f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-07T20:59:50.4041145+00:00"
},
"company_sector_id": "58d3e6e7-08e5-492c-83a8-d944854fe06c",
"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": "6d48b56a-c327-4209-a74e-0d962ed75560",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8e3ae587-cc99-4d5e-9eb5-5b4789b9f4cc",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4421456b-e042-42df-b01d-d83ef2604f2c",
"account_manager_user_code": "sample string 56",
"company_status_id": "7fd50628-7153-4fb1-b934-56b29aa9f83f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-07T20:59:50.4041145+00:00",
"id2": 60
},
"db_language_id": "dda62d52-832d-4023-863b-07bad5366c37",
"db_language_code": "sample string 7",
"db_title_id": "7f44b4ee-3dae-47cc-8236-630151241235",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-07T20:59:50.4041145+00:00",
"create_date": "2026-05-07T20:59:50.4041145+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-05-07T20:59:50.4041145+00:00"
}