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": "9e60b5ac-12ea-44a9-8b5e-032c2e78d20a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "eafb4340-e727-43e0-a9db-db2d8f244821",
"company_code": "sample string 5",
"company": {
"id": "bf942d05-0b4b-47e6-9435-939eb4ff28c1",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-08-06T22:51:18.7474133+00:00",
"sales_territory_id": "5128f18d-a64c-4c72-b63a-e8fb7e919fc6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "eebe32dd-5d12-4e47-9c01-17b08a0644a5",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "5a571165-93bb-4f3a-ad01-b6ed7d6f1fcd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8ea3b8fb-4e40-45cc-a0cc-3503549c84e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8c5527d-e131-4b5c-963d-28cac8e8e3ae",
"db_currency_id": "71a1b8bb-6c86-492e-99f9-88dc9d846b36",
"db_language_id": "15d94f7c-c921-4d49-ba21-fdb2b503a3ac",
"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-06T22:51:18.7474133+00:00"
},
"modified_dateutc": "2026-08-06T22:51:18.7474133+00:00"
},
"marketing_segment_id": "f4aeabca-92c9-488e-bb2d-079973e65222",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5618e4b6-c1f7-43ea-a579-3d19ba1beaf2",
"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": "bc6f7d2c-f5c2-4c10-bd49-6fe4b65d0d13",
"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": "fda35f82-d95c-484a-9d19-90329a1f2ac2",
"db_country_code": "sample string 28",
"feelist_id": "86b573bd-e0df-4c33-8079-534bfee853dd",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "0909ebfa-b63d-4dde-8915-64bdc4aea4de",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "bdb5f09f-02b2-469d-965a-9b7c858f197b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-08-06T22:51:18.7474133+00:00",
"db_currency_id": "5192e4d6-fd6a-4194-9cdc-93283113d196",
"db_currency_code": "sample string 10"
},
"company_type_id": "d39d9380-3701-4021-b363-376f8c695982",
"company_type_name": "sample string 32",
"company_type": {
"id": "00eb2045-9921-49b2-ad10-23e97558780d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f8579a70-da0e-4195-8b1d-926539ed9671",
"sales_organization_code": "sample string 5"
},
"db_language_id": "ee9f9ece-32eb-4f4e-8e11-c1af4ad03f07",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bac0b7d2-1001-4474-881d-d8a345fe05cf",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "eca33169-e571-4764-b054-3d38ff8d80bd",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "f27446f1-87f0-45df-b564-346d732e9797",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-08-06T22:51:18.7474133+00:00"
},
"company_sector_id": "a5bbdfbf-59c8-4510-8baf-61a04a8ad309",
"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": "b1a93d38-252a-4847-9f2e-326e68cde10c",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "06a5a1b9-11bb-4793-ad40-da0601eb6426",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "e061d83d-3c6a-4903-8b61-4fe46ed048cb",
"account_manager_user_code": "sample string 56",
"company_status_id": "fd0635e8-435d-4d94-84fa-fd2f74b2c3d4",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-08-06T22:51:18.7474133+00:00",
"id2": 60
},
"db_language_id": "a5419776-88dc-4670-a0aa-ea018cc6293b",
"db_language_code": "sample string 7",
"db_title_id": "4c00d166-deb9-4f39-910b-c1df6a845d9a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-08-06T22:51:18.7474133+00:00",
"create_date": "2026-08-06T22:51:18.7474133+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-06T22:51:18.7474133+00:00"
}