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": "e5a9bf22-5f7a-4219-a268-54cf3b2786cc",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "6c977897-64db-494e-8e61-6babfe5774da",
"company_code": "sample string 5",
"company": {
"id": "ffde54c7-4004-46d2-b6e4-1240e4b3b230",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-25T09:01:27.6226713+00:00",
"sales_territory_id": "40b48029-9bb1-4465-8a81-5b6a03fd503a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ea5cea6c-8d92-41cc-9caf-8f89960e4502",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "64516786-e19a-4bce-bc83-5a49f314a7ac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0849c255-24b6-4c04-9c6d-c39353b503d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2479135e-847a-4b1d-a06e-effaa8e9951b",
"db_currency_id": "ff57be4f-0096-414b-8e4e-df0c1efa8979",
"db_language_id": "3176acc3-24c5-4ffe-98d6-21047df83ce5",
"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-01-25T09:01:27.6383635+00:00"
},
"modified_dateutc": "2026-01-25T09:01:27.6383635+00:00"
},
"marketing_segment_id": "add4a6b8-1df1-4837-bdb5-0eb734c4e18b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "fb2c9dd0-5876-42a5-b1e4-0a01fdf8ada3",
"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": "4dc5ebd0-88e3-416c-9c13-63d0b4195999",
"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": "3c8bb58e-c030-4507-b134-ba5591035539",
"db_country_code": "sample string 28",
"feelist_id": "ce96e4eb-98cb-45e8-a4b9-23f5f232f7d0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e095b730-6098-4655-a0cd-6046eb539d8c",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "15be6352-6a5b-4d37-b964-8aa4526829d9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-25T09:01:27.6383635+00:00",
"db_currency_id": "a44713fb-0e50-4e42-81c4-0d2e6e7e7bd1",
"db_currency_code": "sample string 10"
},
"company_type_id": "c2087aea-8380-450f-b965-dbfc7a5d61ff",
"company_type_name": "sample string 32",
"company_type": {
"id": "e6684509-3cd2-4562-9eaa-826b49c7dbf6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d6257c0f-c2e6-4548-a5f8-6b667f9e81d9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6eb7de19-b0f3-434f-9e4c-1104d446df9f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "29b781fc-2711-4fdc-81f7-80f19d8cc27f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0390d601-e142-47e3-bffd-b4f20edb8d51",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "00c3719a-05cf-411e-91ee-7247e8e7a876",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-25T09:01:27.6383635+00:00"
},
"company_sector_id": "d1d25b3a-cb4f-4781-a566-cd002236aebc",
"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": "0c3aa614-2441-46dd-a18b-afce538d7985",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "08c0d1ff-af7e-48e7-b0ef-7af4c515fdc4",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "649150d1-3d7f-4a41-bcff-64419e80d836",
"account_manager_user_code": "sample string 56",
"company_status_id": "5c4fafbe-0ae9-4058-be59-97f7f17ec9e7",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-25T09:01:27.6383635+00:00",
"id2": 60
},
"db_language_id": "b7a5afa2-13d5-4034-902f-4e9adb6f15cf",
"db_language_code": "sample string 7",
"db_title_id": "3a2cffb8-2895-4f57-a37c-6dca83835193",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-25T09:01:27.6383635+00:00",
"create_date": "2026-01-25T09:01:27.6383635+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-01-25T09:01:27.6383635+00:00"
}