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": "ce3585f6-a3ca-4e5b-9cee-7e4d80d3089f",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "4124e1d8-c21f-46bf-9066-fba2f70c4af5",
"company_code": "sample string 5",
"company": {
"id": "f9fbd462-72de-40ed-800c-8f059a0be495",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-14T06:45:22.3880698+00:00",
"sales_territory_id": "d823d083-db67-4386-8c11-55d4cb70c86c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8eee37c6-784f-41a5-88ab-f8b5a4aece61",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1d417ead-9b34-4192-8c81-f329346a646f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "65be2b59-d8df-460d-aab0-59478fe2f48f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "69ddded6-a18a-4bc0-a8c2-b8b194e01d37",
"db_currency_id": "5af35888-9972-49e8-a4e5-ba6b5fb6a479",
"db_language_id": "5c0d50ca-6b32-4cc3-9344-bab0292946e4",
"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-03-14T06:45:22.3880698+00:00"
},
"modified_dateutc": "2026-03-14T06:45:22.3880698+00:00"
},
"marketing_segment_id": "27088544-4f8b-4815-bac9-cb4ef964a01c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "287dd45b-6ee5-457a-bf25-f618a7b3f9e0",
"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": "cbdf1e4d-8081-41af-a788-a2c44c9bf361",
"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": "0590ae9d-6680-487e-8a81-61712955eaf9",
"db_country_code": "sample string 28",
"feelist_id": "c57e8507-b550-4590-8754-e7f4e0be9d87",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "13f146a5-6eb6-4e8e-8e53-7ac045d29cf9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "28efa190-11bf-4d9e-8423-4e6e494c1172",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-14T06:45:22.3880698+00:00",
"db_currency_id": "b1ba66d6-a817-44c7-a6a6-f7cd204dcff5",
"db_currency_code": "sample string 10"
},
"company_type_id": "46ecaf9a-c2c7-4477-bb2b-d981a908fb42",
"company_type_name": "sample string 32",
"company_type": {
"id": "5243b991-af5b-4727-9409-b47bd3f0c402",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "813a2352-ab29-4d1b-8be7-e509963caaef",
"sales_organization_code": "sample string 5"
},
"db_language_id": "05d81369-90ec-4c00-b323-65b6c695d260",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3234bb37-8621-484d-a4af-4b0960e0214b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "41dce3a1-97e5-4481-94c5-a933e2b6a8a9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "5f66d5d0-bed7-4c6e-a534-508dcbf07763",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-14T06:45:22.3880698+00:00"
},
"company_sector_id": "83939656-b7e4-4a4b-bae4-29a2591ae3b4",
"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": "65b9e988-0a5f-4c46-9e4b-7a695fcfcd83",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "5588a13b-500c-41f3-857a-db3ea7ec2885",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "18c2cc6a-d5bd-4288-851f-6e514ff32ba1",
"account_manager_user_code": "sample string 56",
"company_status_id": "ca819e27-e6c8-4962-8f99-2dc3f4e0d912",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-14T06:45:22.3880698+00:00",
"id2": 60
},
"db_language_id": "b429d7e7-4be8-47b4-bb4b-ea3a7c950bd5",
"db_language_code": "sample string 7",
"db_title_id": "1099cb42-0b46-4e64-9d65-11985df59396",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-14T06:45:22.3880698+00:00",
"create_date": "2026-03-14T06:45:22.3880698+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-03-14T06:45:22.3880698+00:00"
}