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": "2c9f3db3-9e85-4cbf-908e-81d5e71ccda9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e2a4bce4-45b3-48d7-bc86-b83927c215e2",
"company_code": "sample string 5",
"company": {
"id": "b22ad415-850b-46ac-9be5-05a326b04939",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-26T12:38:39.5771997+00:00",
"sales_territory_id": "5c57baba-b881-4e30-80c2-7263e27cc557",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "5139ebc2-ee20-474b-b119-effed3ff5882",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "93c4f663-ace2-4542-9c26-f7c8558831d0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3852150b-2979-40f6-8183-7ac2592fcb30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "50220d58-1123-43dd-8033-7773d1b7bc6c",
"db_currency_id": "a817efb9-3588-4bba-b900-94aaf4e489df",
"db_language_id": "8cc8aa9d-4f19-4250-b26b-48390c9cac36",
"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-06-26T12:38:39.5771997+00:00"
},
"modified_dateutc": "2026-06-26T12:38:39.5771997+00:00"
},
"marketing_segment_id": "903f6fa2-5305-4870-a9df-e4433906234f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c48431b4-3a6e-42e9-8fc0-0b6f139a2132",
"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": "0b51e9a4-46ff-4418-95ca-9c47547885fa",
"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": "41aaa95b-7771-4b57-9a6e-ac850031d5c8",
"db_country_code": "sample string 28",
"feelist_id": "9967d259-6b4a-46f3-ac80-bedd2d5dd36e",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a07621bf-40b1-4278-92d4-9aec07e8123b",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fc4f606d-42aa-44e2-94f5-c5115e863992",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-26T12:38:39.5771997+00:00",
"db_currency_id": "d9e079e8-786a-4e86-a2ee-791b32ee30bd",
"db_currency_code": "sample string 10"
},
"company_type_id": "735b498d-1001-4635-8e78-b74b8e570398",
"company_type_name": "sample string 32",
"company_type": {
"id": "a2092efe-2f9a-4c32-aba6-5e7d3ddc7f15",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e487d0a1-45ae-4991-afae-5a37262cb92f",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d9adf889-e527-45a0-a942-b9df2204b444",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e2ec65a4-a4b0-4472-9e58-09292201d17b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e997f90c-9423-4071-829f-6551de02541c",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "20672716-e5fe-4a7e-b0a2-8e2f54e48fb0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-26T12:38:39.5771997+00:00"
},
"company_sector_id": "d6261468-ea16-4321-81f8-bf95275b0db0",
"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": "2e1f0c78-02d6-4f8b-aaf5-8fe29c695225",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "eacd11b7-aa54-443f-9c36-ab97d37b4de7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "550df91b-7a3c-4577-acc9-2f528c59c533",
"account_manager_user_code": "sample string 56",
"company_status_id": "cd2c04c9-d2f4-4e62-a25e-5e46345af110",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-26T12:38:39.5771997+00:00",
"id2": 60
},
"db_language_id": "2f6dfbee-37aa-4941-803b-bc0d2b1ae8d7",
"db_language_code": "sample string 7",
"db_title_id": "42685c2d-8ffd-4547-8713-090c5f20d791",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-26T12:38:39.5771997+00:00",
"create_date": "2026-06-26T12:38:39.5771997+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-06-26T12:38:39.5771997+00:00"
}