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": "f393f046-bffc-4901-a4d8-4944cf4d7bf8",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "b977cfba-3b04-41f1-96d1-a56f23c9d024",
"company_code": "sample string 5",
"company": {
"id": "f3395c5a-6648-4523-9c4c-0226c5ccec09",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-24T00:17:10.6893692+00:00",
"sales_territory_id": "f8559ed9-05ec-4eda-afa7-aa7a8858112d",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "efa37154-1eb1-413e-96cd-9369c23e9715",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "e5363002-86b3-4937-89e7-c6937438be93",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "98650e22-d1a9-47a2-8155-fc492ad33c1e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4fe9463-2068-4288-8885-3f51e6e1b770",
"db_currency_id": "a942376a-d2fe-43d0-aedd-69bd750316df",
"db_language_id": "84795631-b293-431d-95c3-b961f9bb1323",
"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-08-24T00:17:10.6893692+00:00"
},
"modified_dateutc": "2026-08-24T00:17:10.6893692+00:00"
},
"marketing_segment_id": "60423121-29b6-4989-8cbc-75bec7c3d50d",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "3e6e3191-8bde-4ec8-9246-49d8c903a975",
"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": "ca786eb9-650e-4c4c-9b3b-7ddf862a1f29",
"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": "95b44a77-7421-45f9-9f7c-369111194656",
"db_country_code": "sample string 28",
"feelist_id": "106083a6-fd57-43d0-8327-458da38b5d8f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "845324c8-3d3e-4085-aed5-da56df8e59a4",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "36341003-4fbd-4a23-82c3-ad24926cf5a1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-24T00:17:10.6893692+00:00",
"db_currency_id": "e1e09bb6-5ec4-4ba9-af84-1b5566623dbe",
"db_currency_code": "sample string 10"
},
"company_type_id": "5e49bed8-c100-4580-bf0d-8e1f57d0894b",
"company_type_name": "sample string 32",
"company_type": {
"id": "ae9674cd-1b85-460f-b547-eaff3057b017",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d16f53a4-f651-4d20-8b4e-daba335a2cbc",
"sales_organization_code": "sample string 5"
},
"db_language_id": "2723fc5f-815b-45cc-aa48-41b4c23670ca",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "6c1a7c10-869b-41ba-b6d2-895fe354619b",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "154b1e9f-f482-4786-bc47-1db1f2c5e25e",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "998a9e9f-4a93-4f18-847b-7e26a3438e23",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-24T00:17:10.6893692+00:00"
},
"company_sector_id": "34a3f309-df50-4dd4-86eb-81f39145c10e",
"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": "8f16f95b-0706-4a7d-a2ce-8e7bde65486b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "50730200-b3f9-4404-9f24-4db9a593e7c7",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e931fafa-e8dd-4b03-881e-2bc09d1e535c",
"account_manager_user_code": "sample string 56",
"company_status_id": "9396a19a-b045-464d-9e73-4cd1dc3cbeb2",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-24T00:17:10.6893692+00:00",
"id2": 60
},
"db_language_id": "0f234d0f-1c84-4243-801d-ba70ab0ec4fe",
"db_language_code": "sample string 7",
"db_title_id": "478b14cb-a1f4-43c0-9568-f5709c4701de",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-24T00:17:10.6893692+00:00",
"create_date": "2026-08-24T00:17:10.6893692+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-08-24T00:17:10.6893692+00:00"
}