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": "55204203-586a-49bc-b0df-0e9ff30a2a9b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a9b43f6e-1732-4abf-996a-f3796e8f43a5",
"company_code": "sample string 5",
"company": {
"id": "df8f9c12-c66a-4741-b883-19bd9ba9cffd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-09-04T20:24:54.4615037+00:00",
"sales_territory_id": "b724bc4b-7858-475e-8549-b4d4a38ff7f8",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ac6ff18c-3d00-40d8-a74c-56339c8d995f",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "927f6348-0e5a-4c43-a966-442b2c8c301b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b7cfcc6a-04d1-4027-a61f-add6238c20bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b664c74-dfd9-43c4-9d49-73b7990e5a88",
"db_currency_id": "4d875f55-2c74-4c5a-ba3c-57d96c52e324",
"db_language_id": "5254fc09-1424-4c82-b086-48ae9dd04b09",
"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-09-04T20:24:54.4615037+00:00"
},
"modified_dateutc": "2025-09-04T20:24:54.4615037+00:00"
},
"marketing_segment_id": "bbcb9583-6460-4538-8240-910da57279a1",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b45fbfbd-3745-4c33-9f8d-5a17e0ee7306",
"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": "dad75336-1a9a-48a8-8d31-e0741a0df42e",
"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": "44768cb3-b850-4a52-a9e9-bc52bf472f11",
"db_country_code": "sample string 28",
"feelist_id": "27a1e2c4-4444-4a96-899e-304c5d428f3e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "460e5e95-eada-44a5-8623-77307cd07918",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3d6f2d8e-1411-4847-be0b-994598e7bb92",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-09-04T20:24:54.4615037+00:00",
"db_currency_id": "b4709df6-ec9a-470b-9a59-0f213871113c",
"db_currency_code": "sample string 10"
},
"company_type_id": "7e47308c-0c2b-49f3-aec8-82e528e296ee",
"company_type_name": "sample string 32",
"company_type": {
"id": "11291a90-4edd-481c-a3d8-d30cc37d00ca",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "28b96f4d-8576-4c97-8ed8-f32dadfa0083",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d5ec030a-2285-4d49-af5b-51592426d669",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f547ebf5-23a3-4192-b5d8-c1d7bcf15496",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "33614202-f07f-4263-a36b-708cc90dc5c5",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "0cf2aa33-2fd9-4f9d-b3a6-a00062ebb17e",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-09-04T20:24:54.4615037+00:00"
},
"company_sector_id": "451e2989-231b-42aa-bebb-a21a3a02d12b",
"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": "dadaf4e1-a16d-499a-af63-d9160c827407",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7d90a90b-265a-431d-a977-7a23bdc33ff2",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "09edb28d-32f2-4eae-97a7-8d0048079c4e",
"account_manager_user_code": "sample string 56",
"company_status_id": "591ba6df-9a06-4fd4-9920-5943c8e0fffe",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-09-04T20:24:54.4615037+00:00",
"id2": 60
},
"db_language_id": "f40be43e-854c-40c4-918f-499a6b1f84b7",
"db_language_code": "sample string 7",
"db_title_id": "fa538cb0-873a-4137-8053-c2dff8f67912",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-09-04T20:24:54.4615037+00:00",
"create_date": "2025-09-04T20:24:54.4615037+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-09-04T20:24:54.4615037+00:00"
}