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": "96620f85-d2ab-485c-993a-c526faf982d2",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "bf67960e-e3c8-4749-b394-36b883b6a5bd",
"company_code": "sample string 5",
"company": {
"id": "5a8e5c3c-947d-4397-bb70-d55b247fcf46",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-12T06:11:28.328738+00:00",
"sales_territory_id": "1cd12444-b084-4dbb-9a92-77b1a1e03b5e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f6131a62-3299-4c25-9927-dcc380ea7932",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "093773c1-d757-42ca-bb7f-faff3a6a3a44",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0f6338cf-010b-44ed-a6bf-8ca8b88e5618",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "27637bd9-30c1-42de-8d56-29e5ea280a07",
"db_currency_id": "0c18a1da-804a-44a5-b7b5-7ac578b29aba",
"db_language_id": "fe66824c-8b7b-4200-a05b-270101e0dffd",
"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-03-12T06:11:28.328738+00:00"
},
"modified_dateutc": "2026-03-12T06:11:28.328738+00:00"
},
"marketing_segment_id": "13619d31-6519-4170-827e-87c6981ea6eb",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "6f4f9694-7035-4d85-922a-74a61812b7da",
"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": "fdc5e00c-6aeb-4014-9132-38095c5f6188",
"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": "64cec762-737d-4145-901f-71561db10c12",
"db_country_code": "sample string 28",
"feelist_id": "4eead2cb-08c0-43ed-9189-6ff5f1d88cae",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0bb39d67-29cc-419a-9822-ad1f23d77db8",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e563b5c6-e042-4c63-85a1-4ca2147f9ddb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-12T06:11:28.328738+00:00",
"db_currency_id": "6a079192-d27e-4ac8-84a8-51677bd15f64",
"db_currency_code": "sample string 10"
},
"company_type_id": "193d8a7c-4364-4fb0-bbe5-394b9a76e0c3",
"company_type_name": "sample string 32",
"company_type": {
"id": "63ab8400-a6cd-493b-b9b6-1aedb71cdb26",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "70dda045-5869-4402-8a5b-e61ca8f15f54",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f60abde4-4adc-4e2f-b09c-0d656e838c54",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "fd299f93-ffce-4a9f-86c8-9b2fbbb4890d",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "81ecd6de-953d-470b-a850-13f731bcb051",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "cd7e87b1-0988-4c2f-b1b8-c5ffca56a4c9",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-12T06:11:28.328738+00:00"
},
"company_sector_id": "1fafe669-585a-47e6-a1d0-a872fa6a42fd",
"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": "db541a7f-522d-4544-b476-8974bd748fc5",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "12a7faa6-f460-4df0-b038-a941524de706",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "91b528ba-38fc-4a3e-a8d7-be37ca79c991",
"account_manager_user_code": "sample string 56",
"company_status_id": "82e66299-31f8-48b4-8545-323326d764ed",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-12T06:11:28.328738+00:00",
"id2": 60
},
"db_language_id": "225ce8c8-620b-4bfe-9d12-7d3a80a9186d",
"db_language_code": "sample string 7",
"db_title_id": "8ba9b298-a818-4d63-9d50-19a9f13991d9",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-12T06:11:28.328738+00:00",
"create_date": "2026-03-12T06:11:28.328738+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-03-12T06:11:28.328738+00:00"
}