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": "a5c7a92f-3ae8-4cbb-8538-d0db2ad250bd",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "8fc659f2-e0bc-46db-a31f-dcb6cf8efd90",
"company_code": "sample string 5",
"company": {
"id": "5778f158-78e3-4706-9a87-734f66c28deb",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-10-16T04:42:10.9381557+00:00",
"sales_territory_id": "31c6d00a-6ce9-4e10-a50f-69f35b082d45",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e7389b84-9e1b-42b1-aef4-448f912fba23",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "6a01d3bd-16c3-4876-b66f-fd58561e4d6a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7526e786-336f-4c49-b042-aaabb53fbb93",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3d67f549-3a97-418b-9d27-380c8b2b213b",
"db_currency_id": "ab9096df-16c3-4eb3-86d0-611b5309f140",
"db_language_id": "91415cb9-a839-45cf-9c8d-45568a81adc2",
"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-10-16T04:42:10.9381557+00:00"
},
"modified_dateutc": "2025-10-16T04:42:10.9381557+00:00"
},
"marketing_segment_id": "a2b28d36-34c5-491b-b5dd-13cea081a500",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a65ef77d-d410-4ee4-8971-485b262c5bf5",
"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": "333f8a80-b914-4e50-94f9-1ef5366a7081",
"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": "d539b6f1-a86c-4038-a307-5b7be5e444ec",
"db_country_code": "sample string 28",
"feelist_id": "fcf17ce9-cb12-48bc-891b-c88c6472bca7",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7b941ddf-6c94-4d2c-a312-826ca4c7015d",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "349756b4-3cb6-4764-981c-e82f4fc7627e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-10-16T04:42:10.9381557+00:00",
"db_currency_id": "3f1a2d77-8bf6-4579-9d96-4b1160fd94d5",
"db_currency_code": "sample string 10"
},
"company_type_id": "69033e8b-74ed-4e67-b0d9-220e0d9f3542",
"company_type_name": "sample string 32",
"company_type": {
"id": "3ef259fc-3ff9-402b-bc21-6a7b2ab95347",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bba101a6-5cab-44df-ae9d-a10aec39a61d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1a85044f-c1d1-4ebb-a7dc-e478954238a4",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b5524174-7ab8-4b97-8c86-7f0b94a47533",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "5552c817-b56f-4144-94b4-aeae4b208c15",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "87c3131d-c3be-45f7-9b27-f4d6b8ceb865",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-10-16T04:42:10.9381557+00:00"
},
"company_sector_id": "a3c899d1-1104-473e-83a5-17a8f9082da6",
"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": "ad5f8b90-985a-4c0b-a6b1-b93a90e3fb2b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a1f8407e-b4d9-40e7-9a68-2e9c8fd48616",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4fda8f1b-233d-4483-bc92-13e0c79abddb",
"account_manager_user_code": "sample string 56",
"company_status_id": "a053ca68-21b9-4e90-8bc8-8df4fc92bf95",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-10-16T04:42:10.9381557+00:00",
"id2": 60
},
"db_language_id": "4f1ff153-a040-4094-939f-f29221455c08",
"db_language_code": "sample string 7",
"db_title_id": "89f97a61-879d-4fb1-b329-b8b940a70827",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-10-16T04:42:10.9381557+00:00",
"create_date": "2025-10-16T04:42:10.9381557+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-10-16T04:42:10.9381557+00:00"
}