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": "ce08efeb-9e57-4299-9684-899d771b282b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b93f56bd-1bef-4283-81c0-0cbd055e9176",
"company_code": "sample string 5",
"company": {
"id": "2dfbf702-9510-4fbd-a588-516aa44d936b",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-04T01:24:41.7703949+00:00",
"sales_territory_id": "b1ce72a4-494c-4c72-b20b-bb5fceaa2d13",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1a80255f-a6e3-42c3-8040-58391d692399",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "93309f48-eb9c-4c4e-bf9a-baad5d514225",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fea3ba4c-b635-449f-9327-6c874d2acfca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2b0eaf37-5cf5-43a3-8355-abfe34991bd0",
"db_currency_id": "cff4c7fb-7ce3-4b54-b041-b4363aa24919",
"db_language_id": "91f77813-5c25-4444-8b8a-6af1236c5b91",
"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-04-04T01:24:41.7703949+00:00"
},
"modified_dateutc": "2025-04-04T01:24:41.7703949+00:00"
},
"marketing_segment_id": "286d5094-b2de-4337-b3ab-2c93edac5fe2",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "02a15b84-c049-43f4-823d-48be1acd0c91",
"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": "136a6744-e411-4aa7-b264-df08087ed144",
"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": "67fa94ca-9b45-4efd-9330-39277b1c3b56",
"db_country_code": "sample string 28",
"feelist_id": "9406693c-20c6-4238-8c0c-5e7d5f964b33",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "dd253a2a-6eaa-4dce-ac73-32cbcf2c2f9e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "302f7a4e-80e2-4458-936a-b42dd3e3839e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-04T01:24:41.7703949+00:00",
"db_currency_id": "3d94b3c7-b66c-44a0-b98c-edb544bdf6fb",
"db_currency_code": "sample string 10"
},
"company_type_id": "2b9859f7-89d4-42fd-ae02-81f2b735dede",
"company_type_name": "sample string 32",
"company_type": {
"id": "3535f007-3ebb-4e95-afd9-89da2f65d379",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "0a98f6bd-0716-46d1-a852-1fb4a50c81f9",
"sales_organization_code": "sample string 5"
},
"db_language_id": "860734c0-b0bf-4c4d-af76-54fe0ab721ae",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3423b17e-3349-4f14-815a-b470cde9d586",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "fed4a652-c6d5-425d-bf7f-1d58b4ffddb3",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "289af101-83ec-401c-992d-6bdb20086217",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-04T01:24:41.7703949+00:00"
},
"company_sector_id": "447060c1-9e3b-41a4-a604-8e066ed3d179",
"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": "83a07df2-ea40-4402-8c7d-4f6e1015339e",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "834f7212-585d-430d-9792-8fd6b7b9a19d",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e0219afd-7c43-47b3-9f7c-5ecd0f6a2daa",
"account_manager_user_code": "sample string 56",
"company_status_id": "1e32abf6-ba3f-40af-9eb5-741c79db927d",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-04T01:24:41.7703949+00:00",
"id2": 60
},
"db_language_id": "c039f4c8-d469-41e0-8770-11ae97718655",
"db_language_code": "sample string 7",
"db_title_id": "2cbd3e42-dcc9-45f4-b751-6f2b422d33cd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-04T01:24:41.7703949+00:00",
"create_date": "2025-04-04T01:24:41.7703949+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-04-04T01:24:41.7703949+00:00"
}