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": "a781650e-9810-4a9f-93f4-2cdd1a0853b5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0536b4cd-aa88-4c2c-818a-75e74a07a689",
"company_code": "sample string 5",
"company": {
"id": "7750c0ed-98c1-434a-903f-7b5386f6d118",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-31T21:25:57.2247098+00:00",
"sales_territory_id": "9f73d50a-dc54-4ace-9456-ff715bca2d29",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eaf7f98e-8ccc-49e4-9ad5-26da951a7eee",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "32c3fada-ec2c-4df9-bb0c-44b12c71fc49",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dd47c6f3-97ad-414b-96b5-3835d5d87dc7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "33100cc7-63f5-48ca-b7aa-55267438bddd",
"db_currency_id": "679d7797-cc4d-4f2b-a64a-222dfe7fbeeb",
"db_language_id": "7c8896ec-e4fd-4e5b-a852-5b85e55cb5ab",
"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-05-31T21:25:57.2247098+00:00"
},
"modified_dateutc": "2026-05-31T21:25:57.2247098+00:00"
},
"marketing_segment_id": "6cff4073-635a-4594-bb52-1e9cef53b2b9",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "ddb6b213-bd9b-4707-bb79-4512637dee85",
"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": "ae75df7d-19d5-4e36-bab3-d38c4f3fd332",
"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": "19d21a35-a58e-481f-9a56-83ec55e8f6c5",
"db_country_code": "sample string 28",
"feelist_id": "22797acf-e371-4732-81da-aeaebf928334",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "b407e2e1-b397-43e4-968a-2d724a4464da",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bed78ee2-95e5-471e-a1cd-505fcf443ac1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-31T21:25:57.2247098+00:00",
"db_currency_id": "7dc92e25-ab88-466e-8bc1-5f15a7b2bf82",
"db_currency_code": "sample string 10"
},
"company_type_id": "73b7c7f0-9624-474a-9828-9bb98356fc02",
"company_type_name": "sample string 32",
"company_type": {
"id": "09e2c763-dbbf-4053-80e2-26727b6b01e6",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "96a6f46a-c9a7-4208-b340-c4cdddf904d4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d279f78e-c3f8-4b9a-be30-772537ed4770",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5269279f-6197-4dae-a175-5b072a51894a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5d7ddad7-cc57-4378-8c41-d0bb9d4b16d8",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f80abe5e-21f6-4b85-b1ea-061e10f0c0a5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-31T21:25:57.2247098+00:00"
},
"company_sector_id": "ed820598-7033-4c00-9533-facc5bb69304",
"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": "715bd4dc-6298-4411-af3a-d9181c3a9243",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a22e11e0-d215-4d2a-a912-e11294955fc1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d6d1c719-a953-48ab-b7af-c3f95f95e8a5",
"account_manager_user_code": "sample string 56",
"company_status_id": "14e9b156-a383-4be4-b2b9-fd7b37192aa5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-31T21:25:57.2247098+00:00",
"id2": 60
},
"db_language_id": "a80a1092-d20a-4635-b9b6-5f752a314705",
"db_language_code": "sample string 7",
"db_title_id": "a949cb07-ca12-4ec7-aabe-28fcad5f82cb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-31T21:25:57.2247098+00:00",
"create_date": "2026-05-31T21:25:57.2247098+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-05-31T21:25:57.2247098+00:00"
}