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": "80c403a3-1613-46e7-9b38-8651ddd4a15e",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "fec42963-3bf6-4720-b75d-b4d878395743",
"company_code": "sample string 5",
"company": {
"id": "f5987c9f-72f6-4828-ac62-755fe6f84868",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-03T01:15:55.3434036+00:00",
"sales_territory_id": "4fc96fb2-f735-4edc-825b-14456b60b8b1",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "511e0fcb-6c19-4660-af37-8bb13ad391f5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "df274df4-2526-47e7-af78-49325958c7d6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e786cda9-60b6-459b-bf5e-571a793f6de7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ee0c25e-1ab1-4f3d-ab61-44e395fbf951",
"db_currency_id": "f86f336d-40d9-4a2d-b9cf-7fc6a6cee9ea",
"db_language_id": "3b1ebd43-59fb-4de1-be7a-f1e171422c65",
"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-03T01:15:55.3434036+00:00"
},
"modified_dateutc": "2025-04-03T01:15:55.3434036+00:00"
},
"marketing_segment_id": "b98b9532-e32f-42a0-803f-9de7ad133779",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "8421c1e4-5171-4aca-ae0e-c7fc124414d8",
"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": "2172ba9c-946a-4d44-beb9-3e20d7c61d41",
"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": "72db196c-cff5-4789-b144-c1350c44759a",
"db_country_code": "sample string 28",
"feelist_id": "ba62813b-56f7-452c-9bce-640c11997fe0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7976ad86-f049-490d-a9a1-0684ea1255d1",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "b39db104-2772-4818-9126-24ba7e9d1971",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-03T01:15:55.3434036+00:00",
"db_currency_id": "ff6fda40-985a-445b-9984-26406fb48371",
"db_currency_code": "sample string 10"
},
"company_type_id": "57fd6965-8ca6-4de4-ade4-f913c38d800c",
"company_type_name": "sample string 32",
"company_type": {
"id": "e417b6f2-3a69-480a-a814-903e6577de35",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8d3e5148-cf5f-463f-afac-b07a4554140e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "26d6ef51-662f-4768-a698-ca97e648b88a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "80b710c2-095e-497c-bfc2-abadb1e0cd4f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "d5c88a86-92c6-44e1-9992-8b93c021ebc7",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "49a9bf16-6f04-4969-9947-e4ed0eaa6b4d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-03T01:15:55.3434036+00:00"
},
"company_sector_id": "c40da1be-590f-4b88-a850-bcb88f4222c1",
"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": "b161a79b-a0cc-41fe-9eb8-43d111000f1b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "4fe5bb9c-f944-4c58-a9a7-a648e3a0d378",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "51123344-4ee5-4bfb-9ec7-132785eb29a5",
"account_manager_user_code": "sample string 56",
"company_status_id": "5d9a37b0-ba49-4d4e-a44e-d4e0f153a74f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-03T01:15:55.3434036+00:00",
"id2": 60
},
"db_language_id": "4a5118b6-e6a0-4be4-9449-abf4a6e55527",
"db_language_code": "sample string 7",
"db_title_id": "74721048-6e1c-4000-9349-60851c708abb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-03T01:15:55.3434036+00:00",
"create_date": "2025-04-03T01:15:55.3434036+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-03T01:15:55.3434036+00:00"
}