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": "84001552-8edd-4152-b2aa-5d616aac48e3",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f9c7085a-c0e4-4ed1-ab5e-13fbb7b11f9e",
"company_code": "sample string 5",
"company": {
"id": "74d573e1-1c77-401e-90fd-68fc7c1e50eb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-12T16:18:09.7270036+00:00",
"sales_territory_id": "c8d69552-6023-4fab-8b71-4ef4f49c5b7e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "9c8bae0b-d9ee-4bbd-a1a6-362419fcdc85",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "815242fe-f1ad-4800-9f6b-7c7a837b60ef",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "89202172-2385-4bef-977d-65fd2fcecb5d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "43223423-0af6-453d-9467-b814ed0275e5",
"db_currency_id": "de071fca-c99d-4fdb-b6ba-533b440b289a",
"db_language_id": "28cc5de1-6537-4802-8476-ff29aa55bc69",
"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-02-12T16:18:09.7270036+00:00"
},
"modified_dateutc": "2026-02-12T16:18:09.7270036+00:00"
},
"marketing_segment_id": "f0681421-7e5a-4255-a545-f4944ee92d69",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "95c44d1c-824e-439c-be45-ce8e3c37f179",
"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": "9f04cb87-a1e0-4404-9c55-798ed0cbbfe6",
"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": "b25b790d-8c9c-4946-a835-6d19e5dfa83d",
"db_country_code": "sample string 28",
"feelist_id": "3b631b52-0596-4a16-877b-3bcbd6fadabb",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "ceff06e2-f607-45cb-bdc2-329054c46e2b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "74990670-7d60-4f61-bb66-109c75565f82",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-12T16:18:09.7270036+00:00",
"db_currency_id": "921e2fda-8d1b-4bf2-88d9-ae5fe115eba0",
"db_currency_code": "sample string 10"
},
"company_type_id": "63a0994f-c9c4-4233-a6af-f38d1b5bc9d2",
"company_type_name": "sample string 32",
"company_type": {
"id": "df6f4170-8c19-4a0e-9483-682e2ee12d78",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "203a76f9-766d-4694-8b42-487af59b1533",
"sales_organization_code": "sample string 5"
},
"db_language_id": "47d830fa-6595-4246-ad4a-d8ffaad96498",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "04f3e835-f6f0-4f4e-bc17-9d52f1fa2660",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1b68a3e8-3275-4ec1-973e-51ed67d7a605",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "70bbbb48-e78b-4d7c-a9c1-c96e0573fb33",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-12T16:18:09.7270036+00:00"
},
"company_sector_id": "e89b4d67-9d32-4f7f-b69b-fff4a06a59af",
"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": "4ae54a01-c9ec-4e75-8658-0021b76b9c5f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e4ff279e-ad36-49b1-b54f-dd8c44ba6e5e",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "8658e274-7c1d-4e87-a9a7-fada775376fc",
"account_manager_user_code": "sample string 56",
"company_status_id": "5bd2fd63-4b7a-4730-a899-e514dce9244a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-12T16:18:09.7270036+00:00",
"id2": 60
},
"db_language_id": "a4c9b635-f5d3-4999-be48-b3c146e68fd1",
"db_language_code": "sample string 7",
"db_title_id": "bbd0139e-00db-4787-b6b4-fb26ca640048",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-12T16:18:09.7270036+00:00",
"create_date": "2026-02-12T16:18:09.7270036+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-02-12T16:18:09.7270036+00:00"
}