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": "4b197e2c-40e4-4122-afeb-1eca70154f8d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f482312a-a112-42e2-b908-191a5d84146d",
"company_code": "sample string 5",
"company": {
"id": "d07954fa-3c3a-438d-8229-d8d24ade2471",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-11-01T04:34:55.8746066+00:00",
"sales_territory_id": "789a0151-993a-40e1-b1f8-81544e8c808f",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "d1e52693-5300-44c1-9260-c014c73ea2a6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "73eddad1-54c2-448a-804f-87e4ddaeb474",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6ef1a338-f92c-4aca-bac2-49ea90f551c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "174bc981-0a03-4a73-a6ed-dbeba7c585ea",
"db_currency_id": "1d5d3e52-b891-40ad-85ae-7575d277a010",
"db_language_id": "2ad66325-0eea-4b81-af46-fa3b1bee48dc",
"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-11-01T04:34:55.8746066+00:00"
},
"modified_dateutc": "2025-11-01T04:34:55.8746066+00:00"
},
"marketing_segment_id": "9ed3ce15-ae30-462e-a14a-b3b386623f54",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8c3ae0aa-04b7-4559-ad68-0793999eea3a",
"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": "56002301-d6ef-482f-bb8d-8a5d2ef12cde",
"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": "55d18e0f-d6fe-44f3-b44c-838bb1ac491e",
"db_country_code": "sample string 28",
"feelist_id": "150b0a56-4af0-42dd-bd20-a8e4ab320c87",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "47739e48-30d6-472e-9910-9c8c33719e31",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e99e909f-858e-4433-8805-98f294db657c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-11-01T04:34:55.8746066+00:00",
"db_currency_id": "15e93c27-94bb-4fd9-afa8-a6b5519254a5",
"db_currency_code": "sample string 10"
},
"company_type_id": "cc297c85-6c3b-4741-9273-74dd8469095c",
"company_type_name": "sample string 32",
"company_type": {
"id": "8c821148-58f8-44e5-80ec-d9f7b6623105",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2c030ca1-a128-443d-be60-a17cbeb00989",
"sales_organization_code": "sample string 5"
},
"db_language_id": "11339666-f6aa-42fc-8013-4b6d701de17e",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c5cfc3f4-aa32-4426-b8f0-94d6c89dffe7",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0ed051c6-1151-4549-b8d3-4b48bb21256d",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "e27cb238-0dda-43ae-a94b-1cc05a11257a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-11-01T04:34:55.8746066+00:00"
},
"company_sector_id": "d06f8968-6cf8-41aa-8357-3fc7caaf7b95",
"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": "51b2e177-21d2-4abc-806c-97d074ec47a0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "b0f8c359-7cc3-4831-a0ab-8adc5337c198",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "38065ba1-9864-43c4-8266-84b67e4574ba",
"account_manager_user_code": "sample string 56",
"company_status_id": "8269d40a-f95e-4284-8b89-9cb5e9bc04d9",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-11-01T04:34:55.8746066+00:00",
"id2": 60
},
"db_language_id": "6bce28c3-24a1-443f-a19c-1de5321d8671",
"db_language_code": "sample string 7",
"db_title_id": "005672df-5dfd-422e-9300-3cc692fe2e54",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-11-01T04:34:55.8746066+00:00",
"create_date": "2025-11-01T04:34:55.8746066+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-11-01T04:34:55.8746066+00:00"
}