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": "edf6dc89-6f92-4be6-8172-2587cd617896",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "cc7f4518-fb0b-432a-93ba-2ffba0cb6784",
"company_code": "sample string 5",
"company": {
"id": "648715c4-140f-4e78-b5a2-1ec68d204ba1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-01-22T01:17:08.9626838+00:00",
"sales_territory_id": "cd056d58-8132-4483-a10d-aaa676621798",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3b507d4a-c895-44de-b584-3f4de32c94bc",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e63254ec-352a-4f10-9bda-329835d1c4cb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78ebeeb9-7ea4-479f-a215-3484c8911530",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a992c2c1-e894-40a1-9d79-858d4eede968",
"db_currency_id": "41a355e0-bb75-465f-81e5-ee9f61a3fa66",
"db_language_id": "778c89e8-1769-4693-9ffb-2d5ed031730a",
"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-01-22T01:17:08.9626838+00:00"
},
"modified_dateutc": "2025-01-22T01:17:08.9626838+00:00"
},
"marketing_segment_id": "7b2a78b1-9cec-45c0-affc-f661f0ec762f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "381eab83-ca53-47ca-b88c-52068faa366c",
"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": "99ae0a07-235a-402e-8d7e-4cc6f87bf0ea",
"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": "40f74e30-5681-41a8-8b98-cce3c30b2f26",
"db_country_code": "sample string 28",
"feelist_id": "0961f3e2-efd0-47fa-8480-597b5b81abae",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "40045c74-dd66-49dd-8243-0c9553f03784",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "572cd577-15ab-40d6-9c6c-cd70da977a27",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-01-22T01:17:08.9626838+00:00",
"db_currency_id": "ec036fb9-3f9a-4b0f-ad38-3ccb967f429b",
"db_currency_code": "sample string 10"
},
"company_type_id": "5d62e16e-99d5-4575-a065-b61bae355713",
"company_type_name": "sample string 32",
"company_type": {
"id": "4174d8b9-a816-4e0e-aa7b-75fc97f62305",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "aa3d6171-bbb4-462d-ae5c-6bd3ee329e17",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e28189e4-a56c-4a2e-93af-fe98caba3557",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3284a81d-e9e2-4183-884a-24640327dce3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "0f0d7207-f628-48b3-8f74-79fb58cd717a",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f4b93512-60b4-4c20-bfe2-8d84fe3da936",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-01-22T01:17:08.9626838+00:00"
},
"company_sector_id": "d35be933-7126-4c76-8aa9-fc0abd05e56b",
"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": "7946ab34-9618-411a-928e-81794b166fef",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "70117c66-01be-41d3-95ca-83b08c200704",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "6de463c3-0451-4149-a7d8-cf3e9b00bed4",
"account_manager_user_code": "sample string 56",
"company_status_id": "38f01f82-e1e0-4286-b577-6cc0b2999f81",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-01-22T01:17:08.9626838+00:00",
"id2": 60
},
"db_language_id": "c1d2fe3d-b835-4513-b5ca-83d4ff2c09f3",
"db_language_code": "sample string 7",
"db_title_id": "775bcbf2-42c2-40f3-a3fd-fd81df291551",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-01-22T01:17:08.9626838+00:00",
"create_date": "2025-01-22T01:17:08.9626838+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-01-22T01:17:08.9626838+00:00"
}