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": "eb368feb-38f2-4008-ba42-ff174d4cff9c",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1333a3b9-a212-455a-87ec-db6ace0dff99",
"company_code": "sample string 5",
"company": {
"id": "0cdc855e-86d0-4a91-99d9-8073398c2252",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-24T20:53:01.9578256+00:00",
"sales_territory_id": "0f96bd56-96f0-48f8-9052-27213ebb48e1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "03c09f1e-4f4b-4b37-a11c-2e1254588f9a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "78e067e5-21ea-46ed-8e50-82f61aab9cf6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7774d45c-d19d-4bcd-b41a-cbac82bfcb08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b9c89c31-8c1e-42f5-9436-8df5601f7997",
"db_currency_id": "81be20b4-12d4-4e05-a268-83ae1d66f508",
"db_language_id": "ea426a18-2904-4576-bf4c-049c6ad827c1",
"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-09-24T20:53:01.9578256+00:00"
},
"modified_dateutc": "2026-09-24T20:53:01.9578256+00:00"
},
"marketing_segment_id": "d6c6e28f-e7b6-4cf0-8f68-f612e68ccfac",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "cd74b36a-6751-4393-bfd9-7f549c38aecf",
"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": "07b7f116-490b-4095-aa07-623aec62c5a0",
"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": "d6c08bf4-fb6c-4e45-af7c-f247a8edfa59",
"db_country_code": "sample string 28",
"feelist_id": "c9241dcb-272b-47f1-a1e9-8e439095f76f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f75e37cb-9944-4c9d-9c9f-828f3c7d8278",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d68a3d2a-4142-4549-b701-901c6b550400",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-24T20:53:01.9578256+00:00",
"db_currency_id": "d2df17b4-f63b-4782-8095-82373510fe2a",
"db_currency_code": "sample string 10"
},
"company_type_id": "c8ec71e3-2100-4495-a7ac-9eeb0a50b3d6",
"company_type_name": "sample string 32",
"company_type": {
"id": "c45e9fd1-9e8c-4962-8d2a-b256686fed90",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5b60ab86-6a29-4b6e-a46e-862f5a27583d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "8ae906ca-f61a-43cf-9031-b947b728cc21",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6e14a524-f2a3-451e-b144-8666b38c8377",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "36503540-9eb1-41b5-aab5-b7bc53255a88",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "00ececac-e3f3-44e1-8900-2541f9c4a21a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-24T20:53:01.9578256+00:00"
},
"company_sector_id": "f044d40d-d65a-4636-b4c0-3369c246302b",
"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": "b676e7be-144e-42cf-9e56-a651a0ffef01",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7ddf8ed8-b716-497c-9a23-934fd5cfbec8",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "c1481a50-f07c-4822-9ae1-7c03a3a6842e",
"account_manager_user_code": "sample string 56",
"company_status_id": "64284ef8-b8cf-48c6-a4d1-537ae066add5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-24T20:53:01.9578256+00:00",
"id2": 60
},
"db_language_id": "5240144f-cca3-4ca1-a571-3ba143c59797",
"db_language_code": "sample string 7",
"db_title_id": "44fb1e72-8df9-4a2c-ae33-f86203f144a1",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-24T20:53:01.9578256+00:00",
"create_date": "2026-09-24T20:53:01.9578256+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-09-24T20:53:01.9578256+00:00"
}