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": "d52f47bb-3ae3-4e2d-9a41-6c7ea98913be",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "a561376d-a329-4807-98d8-9f73c6c1d40e",
"company_code": "sample string 5",
"company": {
"id": "898ee4e0-ee02-4c03-a11d-6d7c71d920be",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-01T18:07:35.3910969+00:00",
"sales_territory_id": "1d6e9e48-ef55-49fb-a2d7-0abf032ba3fe",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "0ef60256-6030-48f2-aefe-663cc3b819d0",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e464e3e0-2ab0-48eb-9446-28745de8a62b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a51eb8a9-be0b-47dd-a624-ee0544fd2afa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5521a708-c81e-4840-9eb7-4da97592dd3c",
"db_currency_id": "9ad357a7-5da6-4619-80e2-97aa115335ed",
"db_language_id": "fac7fff2-778f-4da3-a79e-0c1d8aa4e1f4",
"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-01T18:07:35.3910969+00:00"
},
"modified_dateutc": "2026-03-01T18:07:35.3910969+00:00"
},
"marketing_segment_id": "374eff7e-9efa-4aa2-a6a9-8b7de88e0db8",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d4d24f67-09ac-4f76-bedb-36434f01d91e",
"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": "3bc0fda6-fced-482f-a2e6-cdf96b447d0e",
"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": "c29a84e1-9ade-4b09-9ad6-082d378c866b",
"db_country_code": "sample string 28",
"feelist_id": "e30ef09f-2c3d-46ba-95d0-d810506f339d",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "96f20b2c-a52d-4f46-b169-9d203aa86cfd",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "afa964f7-dcac-47c4-be90-85bc8a14b5da",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-01T18:07:35.3910969+00:00",
"db_currency_id": "6ea0ba5f-b554-40b9-945e-41d84a929e5b",
"db_currency_code": "sample string 10"
},
"company_type_id": "1fed68e5-cbcc-4f46-82e1-5d2b8988e5c9",
"company_type_name": "sample string 32",
"company_type": {
"id": "2c485ef2-38a2-4a0c-9f23-a6f04c4d22e3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1ed801b2-1215-4b3b-8f86-4316468c85c4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "36518ef9-4192-43de-8f6f-b367b6b4771a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "4c0e8e85-bcba-458f-8be6-4b23ad7bd2f9",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "c0329967-3e03-4e17-b586-10457752b089",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "03ed0844-446d-4c7c-af29-9dc0f9458446",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-01T18:07:35.3910969+00:00"
},
"company_sector_id": "fc1aae9b-ab7c-45ec-9b76-62f216b8a9fd",
"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": "97a0be83-056d-475a-bb0f-ce359ca7df10",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e4523d63-dbe8-4ccd-a185-6846515cd907",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b59f94d9-9f00-484b-96e9-cd9e4a9eae4b",
"account_manager_user_code": "sample string 56",
"company_status_id": "d5e688f9-4ed5-4a54-8af5-90f1dbf4470f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-01T18:07:35.3910969+00:00",
"id2": 60
},
"db_language_id": "9feec5fa-4583-42a8-b48a-b47bced0692f",
"db_language_code": "sample string 7",
"db_title_id": "d601a7b7-078e-458e-9323-e5863d900f67",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-01T18:07:35.3910969+00:00",
"create_date": "2026-03-01T18:07:35.3910969+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-01T18:07:35.3910969+00:00"
}