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": "fd660046-6a44-42c0-b1f8-29ceb0def177",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c8e2a71c-5b03-4b77-b776-7edb4b45224b",
"company_code": "sample string 5",
"company": {
"id": "128cd05b-0feb-4eab-b803-e9c3309d2757",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-06-08T19:14:58.8664236+00:00",
"sales_territory_id": "9238cf20-55e2-4065-bce8-b7f2d162b26c",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ff4dde5e-ffc9-44e8-8247-06cc3968a59d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bf1b3fa5-2664-4411-8326-95be13f898fb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "feaf21c5-7f3f-4c88-bba5-d39ac12b35d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f4438fcf-06a4-4039-85ea-241cf1a5b62c",
"db_currency_id": "1a2351c2-d13b-420f-97f5-5f00030a93a4",
"db_language_id": "d6d29439-71a3-41e8-93ec-b217b62c8bda",
"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-06-08T19:14:58.8664236+00:00"
},
"modified_dateutc": "2026-06-08T19:14:58.8664236+00:00"
},
"marketing_segment_id": "c33eb546-61c8-4de7-950a-0b060e95de1b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a4584ce7-95b1-4ed4-9f4f-23986c2cc7e6",
"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": "f68752e3-204f-4357-a9ca-032e91f2ffe8",
"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": "4c72d8db-ea9c-4e20-a7a1-9d8eb8361b82",
"db_country_code": "sample string 28",
"feelist_id": "db70719d-619e-4e2c-afef-93010c7d3013",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "aace8162-85ee-4e71-9a14-cf23b990c023",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "453cc951-4a36-453d-8bdd-fe7ae639953b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-06-08T19:14:58.8664236+00:00",
"db_currency_id": "2fe38805-e5ce-4112-bca1-27af39ee2250",
"db_currency_code": "sample string 10"
},
"company_type_id": "bd21d74b-2e39-4754-bac7-6958dab60f78",
"company_type_name": "sample string 32",
"company_type": {
"id": "3dc160b2-3877-4433-a218-7a7e085e5f70",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "585e7b9a-ede7-49b2-a6df-b53303a30123",
"sales_organization_code": "sample string 5"
},
"db_language_id": "633adf85-c241-47ad-bee0-f8d75780a58a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "2b41265a-a648-4058-9247-d4c8273bc700",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "22f03864-db6a-464b-82e8-a51de92b7c21",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "7e8b074c-79b7-4079-b623-0e5ce418d57b",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-06-08T19:14:58.8664236+00:00"
},
"company_sector_id": "79d13e62-08eb-4d7c-8470-9da7f6c21f5e",
"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": "6fa8114b-77cf-4bbb-a205-2460eb909e6d",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "c5d5e120-0011-47cf-81ed-c355fa25ff5f",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "b78c1514-a632-46a0-a03b-811f365432f5",
"account_manager_user_code": "sample string 56",
"company_status_id": "cabf7335-0dc3-4fd6-822e-090f79a392a6",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-06-08T19:14:58.8664236+00:00",
"id2": 60
},
"db_language_id": "831ba892-e418-472b-9cb1-fcb6b337ff69",
"db_language_code": "sample string 7",
"db_title_id": "b316699f-7907-4379-9bbc-efc7e8b4fa9a",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-06-08T19:14:58.8664236+00:00",
"create_date": "2026-06-08T19:14:58.8664236+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-06-08T19:14:58.8664236+00:00"
}