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": "3cf8a16d-58e3-43ca-aa30-f5c45fdfc6da",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "0d3db348-2190-4467-98c9-3bfacc2a873c",
"company_code": "sample string 5",
"company": {
"id": "d7a0fc7c-b732-4ea7-8aa2-50bae6876a9e",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-16T10:25:55.9712849+00:00",
"sales_territory_id": "52e91890-94ef-4a6b-ae29-a86777fef784",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "6a3adaed-5980-49a1-b8d7-5b6d91445eeb",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dbc19bcc-48bf-42ab-8453-854fae3d33a1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8f85de2f-71d6-46b8-a97c-221027dee921",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d3456638-c037-4e0e-ba3f-1378bed5f595",
"db_currency_id": "4dc90146-57b1-4c60-beb3-6b271d0f3da4",
"db_language_id": "d5d43fa5-840f-463d-9f00-06cc5ffdceb3",
"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-05-16T10:25:55.9712849+00:00"
},
"modified_dateutc": "2026-05-16T10:25:55.9712849+00:00"
},
"marketing_segment_id": "e2e3edf2-6e13-4e52-92e2-9812576e5510",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "77567c06-eb15-4a13-925f-6f39ee5ef1af",
"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": "1a306689-5db4-4b9b-a93e-ded769cec994",
"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": "1dc910e1-a45f-4574-b43c-d8b6cce16ff1",
"db_country_code": "sample string 28",
"feelist_id": "ca8fb452-b10b-4d83-a7d8-746a935390bc",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "52211aec-4d3b-4096-87f7-2a9a67a75f88",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "3380c72a-08d6-4012-a0ec-770043be9b65",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-16T10:25:55.9712849+00:00",
"db_currency_id": "9675ab9b-f972-4bbe-9715-5bbdfe03ed33",
"db_currency_code": "sample string 10"
},
"company_type_id": "cd6defb8-bde2-4fdb-b24c-f80441ba1ebb",
"company_type_name": "sample string 32",
"company_type": {
"id": "bb2d397c-2dfb-4af2-9783-366a6b0862d4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "1d7281b1-9d4e-44a2-940f-26e9fb26a76b",
"sales_organization_code": "sample string 5"
},
"db_language_id": "53351112-ad55-4a12-830c-fe3389d78bcf",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "795f03ba-77e7-4681-b66f-899c2d11faa8",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "15c46262-1f6c-4603-a9a2-e7429b552577",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "a93aee72-7b30-4393-b8bb-eb041c6da3d0",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-16T10:25:55.9712849+00:00"
},
"company_sector_id": "af6039c6-cdaf-49de-871b-934491566326",
"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": "a6083b93-8964-4184-9c80-ead504ff7cd0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f74f896d-dec7-4b3c-a379-56ca000241e9",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "0b8ac38f-55f7-4b31-bdca-e3bccbf731d4",
"account_manager_user_code": "sample string 56",
"company_status_id": "627cf072-f045-4650-89a2-e21ea61c045f",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-16T10:25:55.9712849+00:00",
"id2": 60
},
"db_language_id": "7b8ddb58-ec9d-4db0-aca2-925c6e981ee2",
"db_language_code": "sample string 7",
"db_title_id": "f5b03fe5-6b05-400e-9906-07c24d9edf88",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-16T10:25:55.9712849+00:00",
"create_date": "2026-05-16T10:25:55.9712849+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-05-16T10:25:55.9712849+00:00"
}