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": "4f7b5753-0614-4f49-8d60-62310bbf9bd6",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "1e33d0de-f068-47a2-83d8-f99293a86d9d",
"company_code": "sample string 5",
"company": {
"id": "3262869b-d805-475c-86a3-eac2ec21174f",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-03T15:01:07.5091286+00:00",
"sales_territory_id": "c87e68ce-4a92-400e-af03-51d2232f8364",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "44c56592-2f35-4db0-9fbe-a0846691e690",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8cfdf06d-0266-4460-a2ba-84c92d1604d0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ff3c03fe-482e-40a2-9386-fdec4afc81b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8009025b-93b1-40c4-9f7b-e36df1ce0831",
"db_currency_id": "9de8ba2c-5c3c-4fe2-a82b-5bad5f114f28",
"db_language_id": "35c1c275-31a0-4ed8-98d1-1edd1fa155c4",
"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": "2026-02-03T15:01:07.5091286+00:00"
},
"modified_dateutc": "2026-02-03T15:01:07.5091286+00:00"
},
"marketing_segment_id": "5f5bf9a5-45fd-4657-b1a7-a2b35031fe02",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "223c7b3a-46a9-4fee-9328-8c02600872da",
"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": "a0a5f134-a023-4e23-a500-350c095d7e97",
"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": "d0bbf19c-6f92-4563-a61f-9f5e55d9b678",
"db_country_code": "sample string 28",
"feelist_id": "faa896cf-f6fc-4791-b0c1-800a2a951a31",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "3cac36c9-903e-4156-b55d-36d61979793a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "18ce5913-f5b2-4172-9092-5d78e4f094cb",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-03T15:01:07.5091286+00:00",
"db_currency_id": "a2cf71a9-0703-4f2f-9ea0-dee5eda6d158",
"db_currency_code": "sample string 10"
},
"company_type_id": "92bb607b-54c7-4cf5-91c7-07d22b622dcd",
"company_type_name": "sample string 32",
"company_type": {
"id": "0bc09031-726b-45d4-9c4b-7fd664f97b6e",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8df8540f-27fa-4d1c-b908-0f88add8e63e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e0781b95-340a-4fd8-a226-901e2aa0641c",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "251cd50d-aa05-4d94-9f14-6ac9c92f73bd",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "32d2cfdd-3a6f-456b-adbd-d59ac3740008",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "20b58f3a-5627-4a66-beb9-403bfa025ed4",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-03T15:01:07.5091286+00:00"
},
"company_sector_id": "62b0454d-4780-4e9b-ab00-3b2798340d5b",
"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": "62429538-1162-4f64-9aa4-1cf84250869f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "34f1521c-efa6-4d79-bab5-818a8e4ffbe9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "101a7be4-925b-4108-8fa2-20c5e4e0ebd8",
"account_manager_user_code": "sample string 56",
"company_status_id": "23f691f3-5020-4162-a3ef-a43a16254a60",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-03T15:01:07.5091286+00:00",
"id2": 60
},
"db_language_id": "939e4a90-f88e-43eb-a5ce-5e95e95c4e61",
"db_language_code": "sample string 7",
"db_title_id": "814acaf1-e278-4c2f-94ae-1c123be9d60c",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-03T15:01:07.5091286+00:00",
"create_date": "2026-02-03T15:01:07.5091286+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": "2026-02-03T15:01:07.5091286+00:00"
}