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": "bb35cd71-242e-430a-aa56-1924553f5ff9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0d80c4bf-3b76-45a5-99d3-8267dae4ba40",
"company_code": "sample string 5",
"company": {
"id": "e3e48c78-4593-4daa-b042-f5841bd70154",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-09T13:48:28.4740093+00:00",
"sales_territory_id": "3972b9b1-134b-47f2-9c59-d3ba7913f184",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "f8ebe77a-537c-4e17-9433-c4adbbaa462a",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e49030ee-73e5-48b1-b4f6-727467d7d30b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6acd001b-afbd-447d-89fe-b610b3032f16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c515a106-2054-4359-bb0f-bd31f13ffb2c",
"db_currency_id": "7d9c5626-2e67-4e1c-93e7-82fcabe3a611",
"db_language_id": "e4f487f1-22a9-4c3e-906d-8fe6f30df25c",
"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": "2025-07-09T13:48:28.4740093+00:00"
},
"modified_dateutc": "2025-07-09T13:48:28.4740093+00:00"
},
"marketing_segment_id": "c12bf4cc-8a38-4875-93a4-eb1298b6d344",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "7a0a5107-f355-45cd-9da6-ebf1e929825d",
"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": "3494fcd6-43fa-4bd2-96dc-2bff33a70044",
"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": "ad02e55c-397e-4995-b246-5ce26aceefdc",
"db_country_code": "sample string 28",
"feelist_id": "f374b8b3-5572-46a4-b907-183dc797a543",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8d434a90-f532-4661-b03d-d52780c628ce",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b65245b0-9cc2-41fc-bf3d-621d4cded9c9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-09T13:48:28.4740093+00:00",
"db_currency_id": "496783b3-7562-466a-aa1b-0cd1e897b9dd",
"db_currency_code": "sample string 10"
},
"company_type_id": "c68bce9d-edb7-4ee5-8ed2-4ae1fd569445",
"company_type_name": "sample string 32",
"company_type": {
"id": "60f3974e-93fe-48b8-bbdb-88054cd981b1",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f2b836b4-dee6-48c6-a436-67dbd11a740f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "909d5de9-a066-4fbc-8f27-a8e9f6cf139f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "543755a1-4fe9-4ba4-a720-1dd696e461c6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "a3b64ad6-f287-4edf-81d0-ac9b32ec1c3c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "828cec0c-d0bf-4f3d-9e9a-e0ef382ede89",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-09T13:48:28.4740093+00:00"
},
"company_sector_id": "be8817fa-409b-4e7d-8f97-ca4965eb1b2d",
"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": "78a06ae4-39b1-4716-b207-b635c54a1b46",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3587a897-5259-47a6-9c20-438affd97bcb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ffe127ea-a204-4bfe-ba4c-b83bd619212c",
"account_manager_user_code": "sample string 56",
"company_status_id": "a4e3289a-b401-4222-bb0d-652165adb247",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-09T13:48:28.4740093+00:00",
"id2": 60
},
"db_language_id": "fc8f0a73-0d74-406b-bcfc-664a59b3f3ed",
"db_language_code": "sample string 7",
"db_title_id": "03fd1e7e-c022-4d00-b525-84e79854c7f6",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-09T13:48:28.4740093+00:00",
"create_date": "2025-07-09T13:48:28.4740093+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": "2025-07-09T13:48:28.4740093+00:00"
}