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": "36771327-f937-4cbd-92d0-8b26a8f26212",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c787ce0d-a799-42d4-a6dc-7615059d24ca",
"company_code": "sample string 5",
"company": {
"id": "4aec43d3-a938-4a9d-94b5-cd1b5d0ea482",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-03-07T03:10:16.5239064+00:00",
"sales_territory_id": "7b1112ca-1294-4026-8838-6c263af74e78",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "06c8a065-474d-46e0-a099-827e424e9ed7",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "2d2b803f-bde9-4616-9ecf-befbd831b537",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b1047029-ee16-47c4-a4b9-dbfc07e11a8f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e37e198b-3aaa-4d24-9dea-3fbd499063af",
"db_currency_id": "48566499-1323-4db6-ab49-e2a0606740da",
"db_language_id": "693ca039-ddd1-4752-94a7-b48b8efb95fb",
"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-03-07T03:10:16.524729+00:00"
},
"modified_dateutc": "2025-03-07T03:10:16.524729+00:00"
},
"marketing_segment_id": "4efc1bfe-2e0b-484e-80c8-7a79adb8932c",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "77385b7a-04f5-48b6-a058-426a0cf0dc69",
"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": "59430f5c-c234-4414-a776-539b1d338ea3",
"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": "09b21f31-588b-4d59-b159-a51bbcc46307",
"db_country_code": "sample string 28",
"feelist_id": "808b76ee-6a33-42fa-970e-9356b48b67f9",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c944c65d-46f9-4d6a-ac7a-3edeaeadfeda",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "5d98e329-a18b-4246-96a3-67b7d4ba339c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-03-07T03:10:16.524729+00:00",
"db_currency_id": "3160486e-cb13-47b5-b0be-97c9b4bc7d53",
"db_currency_code": "sample string 10"
},
"company_type_id": "8b207f0f-6f2d-4c15-be7f-95a208ac825f",
"company_type_name": "sample string 32",
"company_type": {
"id": "c2d59dc9-e48b-436c-89f2-40dec771219a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7bb45ea9-261c-4736-ab2c-fa1b590bd5eb",
"sales_organization_code": "sample string 5"
},
"db_language_id": "190e3323-5bbc-45dc-a5d4-e6bb38bedbd6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b47a0a68-366f-4a36-abe9-ff3ac50c5c1b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "64171d20-b236-4e43-945f-26d91cde6337",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4add0cce-590d-496a-90dc-463c6be58265",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-03-07T03:10:16.524729+00:00"
},
"company_sector_id": "20393a32-f9e5-410a-a281-0ed57f69b1d4",
"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": "7fe927c9-9b47-4ec9-a796-65ec5d2d1382",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "2fb761f8-bce5-4a57-a0f1-8075c335bd09",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a2475caa-270d-42b1-b993-ab2927610835",
"account_manager_user_code": "sample string 56",
"company_status_id": "ff898d12-2da8-4410-ba8f-2b99b48051bc",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-03-07T03:10:16.524729+00:00",
"id2": 60
},
"db_language_id": "0b7dc490-1e1c-4a9d-a224-add9cbb9acbc",
"db_language_code": "sample string 7",
"db_title_id": "2c393665-dac0-4636-b598-2914ed3f3444",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-03-07T03:10:16.524729+00:00",
"create_date": "2025-03-07T03:10:16.524729+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-03-07T03:10:16.524729+00:00"
}