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": "93d747ab-90d4-4949-bdde-b6e516b2678d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0dd7b271-80fe-445a-ad76-a39db86775d9",
"company_code": "sample string 5",
"company": {
"id": "98fcdeae-508c-4e28-8917-f494a0b52872",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-07-10T05:09:22.8092425+00:00",
"sales_territory_id": "7b38b54f-f9d3-4a04-8f00-a5c65466f9d5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "61f58a94-b54d-4581-a903-929bd4f31dc5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1689854d-f1a4-4291-b4c8-2d2aad072228",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "32526102-3c2d-4c18-b85c-2cb8bb8dca24",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "80a9328b-39db-490c-9b1f-5b7a522b70fb",
"db_currency_id": "a36d4f97-9db3-48bf-bcff-6de923b73a79",
"db_language_id": "81311c9f-70e6-4248-8577-ac853af93aab",
"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": "2025-07-10T05:09:22.8092425+00:00"
},
"modified_dateutc": "2025-07-10T05:09:22.8092425+00:00"
},
"marketing_segment_id": "6c7246bd-a11a-4a04-b837-3ea543ab68c4",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "f3282d50-f54c-4d99-8d0f-4b3f15173740",
"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": "1464b11f-8d6f-4f11-89b0-b48cd29d0c6b",
"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": "e521e551-f1e3-4e71-ab84-b6265df4ec9f",
"db_country_code": "sample string 28",
"feelist_id": "fd2cede3-e19e-4ce3-9ee0-8787805bb53b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8da8d471-9faf-45f4-9993-5665d58f77ab",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "8f9c210a-8878-46da-94c5-15fdbd456a7f",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-07-10T05:09:22.8092425+00:00",
"db_currency_id": "7b1258a9-8746-4cf3-9426-3ca061ac577a",
"db_currency_code": "sample string 10"
},
"company_type_id": "ba6c8f67-acd4-40c9-9bac-8cbabaff91c9",
"company_type_name": "sample string 32",
"company_type": {
"id": "e362d9fb-1d75-4054-b8eb-5e70551f9d40",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "82af72a5-2d64-480f-9338-e723271df297",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b47e4d02-6a08-4131-a461-e8da76b99abd",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "380ef74d-15d6-4cb3-886b-ca79cb3b9ea4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "80a9648a-b82c-4007-a55f-62406b8c9a40",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "2841c365-ee95-4518-801e-e49d8ba2d31b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-07-10T05:09:22.8092425+00:00"
},
"company_sector_id": "5784153a-5934-4740-b819-ed56ff88f690",
"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": "8de43c55-519f-4232-9afd-6d4eea7927dd",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e2580c52-bfe4-4497-8dc7-fd981218a5d3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "56516412-a21e-403f-b5d5-ce1a61844ec8",
"account_manager_user_code": "sample string 56",
"company_status_id": "95082f9d-0b4c-47cb-a629-4c18ead35d53",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-07-10T05:09:22.8248677+00:00",
"id2": 60
},
"db_language_id": "b94ee95d-a0ab-4bce-9c82-a554be2bfbe9",
"db_language_code": "sample string 7",
"db_title_id": "9d7da300-38de-47be-9e16-2974ef9e7203",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-07-10T05:09:22.8248677+00:00",
"create_date": "2025-07-10T05:09:22.8248677+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": "2025-07-10T05:09:22.8248677+00:00"
}