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": "962ef29c-f6b7-4e35-a598-e6b8e6d6abbe",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "abf36bae-168f-4af8-bac2-2baa58cb9bdf",
"company_code": "sample string 5",
"company": {
"id": "174319af-a2a6-4d2b-b628-b464f4ac90d4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-21T10:09:55.2038736+00:00",
"sales_territory_id": "533524ce-14d3-4a36-9d59-ad3151f0a3a9",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8ade3ea0-2d87-404d-bfca-375aed80c5b1",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fe2a321a-4588-4438-ba17-439413e7ecf5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "67173006-a020-4ec4-b794-63e0b001bfb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c14961a-4a77-48a3-8a15-d8fa1d37c9eb",
"db_currency_id": "f6256b90-e29c-4285-8206-f153d15c9842",
"db_language_id": "0c6817a0-b296-4b32-85dd-980cc6c2137b",
"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-04-21T10:09:55.2038736+00:00"
},
"modified_dateutc": "2026-04-21T10:09:55.2038736+00:00"
},
"marketing_segment_id": "fb73c23e-eb4a-4a5d-a208-bf552c4185ca",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "1768cebc-8aac-46c5-afe2-bf97380c284a",
"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": "38a6f96c-33b6-41e8-a52e-4421be68d1f9",
"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": "accdae01-cff6-4f77-b15f-607bc3ee761a",
"db_country_code": "sample string 28",
"feelist_id": "34729443-8e34-42f0-bd59-92901b5bc449",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "9c2b1785-f39e-4da3-a023-f877b7eaecc7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "86d90f90-54cb-465c-a9a1-8ad847dc9528",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-21T10:09:55.2038736+00:00",
"db_currency_id": "2b3bf55c-292b-4c01-aec4-b9820a388664",
"db_currency_code": "sample string 10"
},
"company_type_id": "0e6fa0a1-f6b5-4ee4-bd7a-021c75bf16cf",
"company_type_name": "sample string 32",
"company_type": {
"id": "beef5d11-4e79-4a62-a039-1f596271eaf4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e4e311f1-7bdd-4c06-ab5c-3bfa690a9d2e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "bede3335-e122-4d84-a168-9cd03f06e832",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e7618f22-2dc5-4b55-8f71-bed50cb70865",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "98c1afed-bcfc-4101-9338-40a251023d19",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d03cf5bb-3be8-4dcd-ba51-4f9e2df35324",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-21T10:09:55.2038736+00:00"
},
"company_sector_id": "c8b2e4ce-f44a-4f3c-aa79-7b87f4b12a55",
"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": "411f56f9-6a9a-4910-9d83-a55d5bd143ab",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a60c1e54-e3da-48db-86b7-d3fdd7aa2b59",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b6501327-ad19-4448-a3db-7bb0b44a13d8",
"account_manager_user_code": "sample string 56",
"company_status_id": "be187db4-c2f4-42e1-9d6a-2cdfea82eb92",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-21T10:09:55.2038736+00:00",
"id2": 60
},
"db_language_id": "3981c905-e370-46fc-aeb5-1e6ce03a4a61",
"db_language_code": "sample string 7",
"db_title_id": "bcfdb415-fc27-495e-9446-dcea724d0c04",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-21T10:09:55.2038736+00:00",
"create_date": "2026-04-21T10:09:55.2038736+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-04-21T10:09:55.2038736+00:00"
}