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": "a3857351-0919-4ee9-8902-f16bc0083bfe",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "71a7bbb9-447c-436d-b0d1-89b14531a5c0",
"company_code": "sample string 5",
"company": {
"id": "cdee5ce4-8b1f-4b6a-a677-9b2e6f978e54",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-03T02:20:19.5338551+00:00",
"sales_territory_id": "788a2deb-14be-4c80-a0a3-e816270b863f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ab37994f-530b-48a7-9ed8-7f533524b0fe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0bbad3a0-be6a-4995-8893-07dc0e9967b2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "953e9ef5-5ef8-4619-8ccf-03d264be11a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c690027c-e089-4b43-a3f0-91630e377fb3",
"db_currency_id": "370570cf-a831-4710-8456-e0ec948d7802",
"db_language_id": "b23ec5ee-12df-4737-9990-c9f4bd927428",
"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": "2025-12-03T02:20:19.5494937+00:00"
},
"modified_dateutc": "2025-12-03T02:20:19.5494937+00:00"
},
"marketing_segment_id": "bd8887c3-61b3-4933-b3f3-093a19e4a6b2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d3b34065-c268-418e-82cd-bf6666817a17",
"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": "3a929ce0-3c2a-4c4a-8674-3cd0657a3193",
"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": "33188e17-f862-4944-85bf-54018a53c89c",
"db_country_code": "sample string 28",
"feelist_id": "f874b8ff-3cc6-4131-b168-49f82bea20b0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c1825608-779d-4c33-ba56-92f4fd35dd1c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "f3c549c6-51ff-4e80-96c7-0d6baf13045f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-03T02:20:19.5494937+00:00",
"db_currency_id": "a77f4449-d7be-4990-9cab-ccbaac426161",
"db_currency_code": "sample string 10"
},
"company_type_id": "3bdd0e5c-fa4a-4251-bb1d-ac1d5231cde2",
"company_type_name": "sample string 32",
"company_type": {
"id": "f9f25763-cc7a-4442-b862-ce6a894c440c",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "a09bc480-f545-40a2-a81e-de1359dc4146",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e9e67726-867e-4dbe-a5b7-d62258da135c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f8449167-37bf-47e0-8638-dad3f0c9365a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a9ad0625-5240-4d31-bd9f-20bbb7307862",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "15b4c3e1-910e-4d39-87b6-c9b874b88441",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-03T02:20:19.5494937+00:00"
},
"company_sector_id": "5ad74bd6-d281-47aa-84d0-7a0e71564cc3",
"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": "44f1c081-2d6d-43bd-b85b-8995a2a963d6",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c31b452a-4e4e-4c83-b367-07008f98b824",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9b5512f7-c063-49dd-b727-b8aa54d11f70",
"account_manager_user_code": "sample string 56",
"company_status_id": "8b4297e1-8a69-43eb-92e6-9f252b47a985",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-03T02:20:19.5494937+00:00",
"id2": 60
},
"db_language_id": "df6d1fd1-4462-4592-b42a-db4e880525c7",
"db_language_code": "sample string 7",
"db_title_id": "3e088cf3-ba0f-43f1-a66b-217804c66f8c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-03T02:20:19.5494937+00:00",
"create_date": "2025-12-03T02:20:19.5494937+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": "2025-12-03T02:20:19.5494937+00:00"
}