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": "479fa3ee-a1bf-4873-92ee-b235c175ce17",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bc288d97-a976-477b-999c-559e005559de",
"company_code": "sample string 5",
"company": {
"id": "aee59fd0-a889-414a-8e5d-8dda1c68cbd4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-20T23:41:17.7812541+00:00",
"sales_territory_id": "930f8a2d-b29e-459a-8881-8ef1d4b810e3",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "007567bc-b154-42dc-8adf-8ca912c8533a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "18ef9203-d580-4936-8ca6-8bf52a4d5fd3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6a5cad8c-e4b0-4843-8927-338edeab8940",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c31ae549-5b84-435b-a6d9-c42e8a4c2c04",
"db_currency_id": "0698e60f-f6d1-4679-bd57-64cbf26305ea",
"db_language_id": "0b8aff07-f658-4e8d-85c1-003b37dcb7ba",
"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-08-20T23:41:17.7812541+00:00"
},
"modified_dateutc": "2026-08-20T23:41:17.7812541+00:00"
},
"marketing_segment_id": "68a30286-7b79-47c7-b9c5-142a4294cc92",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7b411dd4-5f4d-4b9c-8ba6-6116cb423b43",
"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": "6df007e0-5c01-44d4-8ddf-21fe9e36484a",
"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": "a27a351b-7aae-4c25-93bf-d66405f67522",
"db_country_code": "sample string 28",
"feelist_id": "bdc0e6d9-772d-4ac0-9349-3863272d8f47",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7dc6cd75-43b1-4f8e-a6a6-f1d2e46c1cc6",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "06a32de1-1d93-4992-be97-80a088b3a8a8",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-20T23:41:17.7812541+00:00",
"db_currency_id": "d291f641-3a78-4ec8-b2c7-361862c87bb1",
"db_currency_code": "sample string 10"
},
"company_type_id": "a17987ce-19f4-493e-bb82-a9e2db83c6c7",
"company_type_name": "sample string 32",
"company_type": {
"id": "80b73144-4e3a-42cf-ae0d-7e3600dc9611",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "53854a1a-5a03-4f7f-b156-6847320baf15",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a2ebd18e-fe00-4c40-a0d7-93727655c019",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "7a5fe55c-a834-42b9-8c75-2d8b97bc8c4b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "573c34a3-5817-49e3-937d-9bcf3f80518e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "bde30d34-728e-48e1-9c9a-c77a903ef5b9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-20T23:41:17.7812541+00:00"
},
"company_sector_id": "3b2f1b93-7347-4e43-a1c5-d2e768cb9630",
"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": "ca34191d-55cd-47e2-8393-84b037fc9577",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f054ef59-1f1e-4887-86d0-24daa2a21319",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "1b558a10-1882-497e-9d1f-60a5dbb6c587",
"account_manager_user_code": "sample string 56",
"company_status_id": "c2d75bb8-5921-4ae1-a64c-372886367a11",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-20T23:41:17.7812541+00:00",
"id2": 60
},
"db_language_id": "f73b24a6-aac3-496b-aa7f-34979b14576d",
"db_language_code": "sample string 7",
"db_title_id": "a5b5cd82-720a-4bf4-a458-272b2e5d8f48",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-20T23:41:17.7812541+00:00",
"create_date": "2026-08-20T23:41:17.7812541+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-08-20T23:41:17.7812541+00:00"
}