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": "6cb19b4b-cada-49dc-82bb-5a5690534b20",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b0517cd3-1f3d-4a4e-a661-b098d62df951",
"company_code": "sample string 5",
"company": {
"id": "b697b5d5-0274-474a-bdae-380dd4bd427b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-05T13:59:48.104378+00:00",
"sales_territory_id": "7f34bc08-9c8e-42c5-89dd-9da3907d8f95",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "dab8f16d-c8f7-4818-859a-63100bce2fbe",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ddbf1dfe-c7a6-4df0-b500-16f2df172df3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "62586572-b90b-44ac-ac90-2221e4ded039",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8ad366c7-ecd1-46f5-b3c7-fc4995952680",
"db_currency_id": "8dee1f57-25ed-4090-a594-e6877ec36f9a",
"db_language_id": "ae8f5cd0-fccc-4088-b7a6-6ec0cd8ebbc9",
"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-08-05T13:59:48.104378+00:00"
},
"modified_dateutc": "2026-08-05T13:59:48.104378+00:00"
},
"marketing_segment_id": "8f776e24-0d98-4406-85c1-1994043b4b6d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "40a8b069-683e-43ef-9bd3-95628c1502c8",
"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": "dad0cbe2-3d9a-45ee-ad07-c9703ddea213",
"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": "61e75483-c617-4640-b5ab-5f8ba405cf12",
"db_country_code": "sample string 28",
"feelist_id": "876cc8a7-c277-40cd-af4c-aa619b653fe8",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "713d2bf8-2028-4f8e-9761-a27e4966bc44",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "87a5a2b3-6e5f-4a89-8368-23877bf87f64",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-05T13:59:48.104378+00:00",
"db_currency_id": "0e1b9db9-9a26-4b22-9fc1-1d35bbadb9a1",
"db_currency_code": "sample string 10"
},
"company_type_id": "572862ca-71bf-41fa-b1c5-e642d9cc28fb",
"company_type_name": "sample string 32",
"company_type": {
"id": "809e6d29-67c4-48d2-a356-a23f8bef53ea",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3308f214-be67-47ed-8c85-faf0d0ffd774",
"sales_organization_code": "sample string 5"
},
"db_language_id": "d44a5bba-e8e7-472e-8cda-785c154e4a68",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6975e95e-2ec2-440d-9637-56ee200eb3c6",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "afaf2d40-bd1c-46e9-a376-fe0ed71867e0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b9380dce-5762-47a0-a49b-3d226afc4d9c",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-05T13:59:48.104378+00:00"
},
"company_sector_id": "e18095df-e58f-4566-8f56-a697bded3b70",
"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": "fe80bb79-532d-4f9f-898c-bb17dd79acc1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a7c7e20d-7a4b-4216-830b-366afd3c522a",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "22593c53-a132-4e2f-b392-86edeaf8f049",
"account_manager_user_code": "sample string 56",
"company_status_id": "8ef68e15-74dc-451d-bacb-9b0f69a256dd",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-05T13:59:48.104378+00:00",
"id2": 60
},
"db_language_id": "b6b2c55e-49ae-49d5-9a1f-ca6b8121923e",
"db_language_code": "sample string 7",
"db_title_id": "79581ea1-c862-47cb-8da9-20e0ae718343",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-05T13:59:48.104378+00:00",
"create_date": "2026-08-05T13:59:48.104378+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-08-05T13:59:48.104378+00:00"
}