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": "f34ee0f1-7dc6-4f38-88fb-f5e4987a9dda",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1095e9b0-d6df-47b4-87bb-7fcf02ff7506",
"company_code": "sample string 5",
"company": {
"id": "42c94a0d-6cc1-49a1-84c2-79225ece33c8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-05-16T04:36:37.9104572+00:00",
"sales_territory_id": "83dfa495-f53c-4563-b56f-bad799b64093",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "25c5cacd-d379-4610-b1ba-775bfbc6258c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "803aac67-36bb-4723-b392-741837590bc8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6682983d-e248-45cb-9f43-dd3ca5598539",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6b4c93c7-9846-4234-b108-69a1b9319cea",
"db_currency_id": "ac0a6806-96cc-407f-a573-a10cdda7bc63",
"db_language_id": "6723c5ef-3ce0-46e2-9c05-1b0300b6ac69",
"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-05-16T04:36:37.9104572+00:00"
},
"modified_dateutc": "2025-05-16T04:36:37.9104572+00:00"
},
"marketing_segment_id": "07c0298b-e054-46b6-ad24-60ecf450a883",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "de803433-7f34-4ab5-b42a-f095db5dbad5",
"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": "da682978-5e80-4e00-8697-7c9e9ab3d6fb",
"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": "2a28361b-1549-4a00-94ed-72cd8c44a876",
"db_country_code": "sample string 28",
"feelist_id": "3274e9dd-35fd-4ec1-ade9-b19c3da6df8f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "8e6ec03f-d875-43b2-bde7-57f29dadfcea",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "86c1043c-05d3-4c8f-9e2e-71f47f41fbb4",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-05-16T04:36:37.9260829+00:00",
"db_currency_id": "022e5c22-b39b-485d-9968-97c6174da685",
"db_currency_code": "sample string 10"
},
"company_type_id": "8bcd1834-bc99-49d6-ba93-f26d330f4783",
"company_type_name": "sample string 32",
"company_type": {
"id": "c3a40b33-3d71-4482-93b0-b7c4ea503517",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8af2896c-5c6d-4a24-8f81-074601680bc4",
"sales_organization_code": "sample string 5"
},
"db_language_id": "a45afd88-0d92-4adc-84b8-207c31f49fae",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "3e09cb3d-354e-4218-ab5a-fd1de1a5b86a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "6713857f-8123-4bf7-92ed-2c9929a6d6ec",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "c7688a84-146b-4d34-875c-71d9ff8e35d4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-05-16T04:36:37.9260829+00:00"
},
"company_sector_id": "610f13d1-4213-460e-8ec4-c3f408578142",
"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": "2b55f2c1-4c59-47c2-ab9a-9eb47a3a1cf1",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "dfb8cf0b-5026-4af1-8f85-7b4e6c20b167",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "a8620dcc-2801-4413-80a0-6b3fab27b6a2",
"account_manager_user_code": "sample string 56",
"company_status_id": "285a0d14-75f1-4900-af32-056fac1581cf",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-05-16T04:36:37.9260829+00:00",
"id2": 60
},
"db_language_id": "a0627731-998a-4e02-96b3-596500b12d3a",
"db_language_code": "sample string 7",
"db_title_id": "e80b12b8-9684-4766-8df7-d4a7cc7249b4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-05-16T04:36:37.9260829+00:00",
"create_date": "2025-05-16T04:36:37.9260829+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-05-16T04:36:37.9260829+00:00"
}