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": "fa49f0b1-ae43-47ab-92ed-1c860a35cb93",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bd658ac5-f0b9-4e0d-a9a4-d1c049df2a8e",
"company_code": "sample string 5",
"company": {
"id": "5f4b216b-07fb-4091-8fa9-c9a6c59e617a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-07-15T21:46:26.8359982+00:00",
"sales_territory_id": "28877228-68a1-484b-b08d-f13a16de1eb6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bece843c-1efa-4e8b-94b5-b652c3a0a517",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ccf0f284-a847-4814-9d1f-215134f86496",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7db3911d-9664-434d-8752-5eb8f07bb37e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "31330137-ea53-473a-abbd-94b65255304c",
"db_currency_id": "176e1939-3e46-4112-bdec-86c58ee9d47c",
"db_language_id": "d3bdaf66-deac-43bd-91bf-17b98dfaf318",
"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-07-15T21:46:26.8359982+00:00"
},
"modified_dateutc": "2026-07-15T21:46:26.8359982+00:00"
},
"marketing_segment_id": "050322b5-783c-4182-b4c3-dd1b2c20f22d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1eb289fb-f51f-4119-90df-cf000981c79c",
"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": "8e09cd8d-cd23-47e5-91ec-1bf878c2d464",
"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": "61d6b924-c24e-49ce-8a6b-cf8892d72d2f",
"db_country_code": "sample string 28",
"feelist_id": "3f71911a-30ad-4b23-baf5-eaddb8c0445f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "bd30a987-9463-47e4-97af-738057950c17",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "15a045cd-2b41-4bb6-a160-514651a90e68",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-07-15T21:46:26.8359982+00:00",
"db_currency_id": "1a61a764-74fb-452f-a702-068ae29144db",
"db_currency_code": "sample string 10"
},
"company_type_id": "9c7feb90-2db4-4653-b126-220283dc7099",
"company_type_name": "sample string 32",
"company_type": {
"id": "90167ecc-6d70-4791-b60a-21299684bd99",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7cee4c6b-f210-45eb-9687-076ff7626e3a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "9971063e-e097-4159-b3d8-7ccde26defd5",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7784ac50-e32e-406e-b01b-e8275c4ddcea",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6e8ec013-ca97-4af6-8b13-9044afc3bbc4",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "73eb3cf0-4fed-4de7-b7da-2fc4fa283587",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-07-15T21:46:26.8359982+00:00"
},
"company_sector_id": "077f26fa-a433-4436-8f6b-37a8116de769",
"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": "fce0fd1f-9d9f-47e9-9fe2-9d8abe684840",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "91075958-4548-42aa-8a66-b86170e62493",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "796456f0-1da5-4650-97ab-4c64e81fdd09",
"account_manager_user_code": "sample string 56",
"company_status_id": "c3f51248-a8c8-4175-b7b1-5cac72ad00b4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-07-15T21:46:26.8359982+00:00",
"id2": 60
},
"db_language_id": "75de14fd-0eea-45a0-a512-793c60c3cf72",
"db_language_code": "sample string 7",
"db_title_id": "767a2a8f-00e1-4e5b-9c97-f375b902dc8a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-07-15T21:46:26.8359982+00:00",
"create_date": "2026-07-15T21:46:26.8359982+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-07-15T21:46:26.8359982+00:00"
}