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": "dffcd2c2-5f0e-4844-a16e-83a2b338944b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f1e7499a-ff82-429e-af5f-b45cf2152a24",
"company_code": "sample string 5",
"company": {
"id": "1cce9bac-0258-4400-a7fb-9fb66c75651a",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-18T00:37:23.2415227+00:00",
"sales_territory_id": "193c0a1d-c927-428a-8910-d65ad54f8891",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "bfb6ee4a-2607-4834-b87e-1d46f33a2161",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "318d51a0-b178-447d-943b-d3b957e5c6f7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fa67c850-2667-45ae-850b-935cf721f325",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3382a00a-274a-4501-b432-71f36e034918",
"db_currency_id": "70464600-8682-45ea-8cb1-debeea5e1619",
"db_language_id": "29d0297b-e516-4fcb-84c3-0abec0589328",
"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-09-18T00:37:23.2415227+00:00"
},
"modified_dateutc": "2026-09-18T00:37:23.2415227+00:00"
},
"marketing_segment_id": "c035193f-56f6-4419-91ca-7634f3fe6fd0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a542e969-db54-426b-a740-f4acdca06201",
"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": "1e5613d9-38d7-48b6-9836-df52704a9c77",
"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": "4d61cdd1-09dc-4a1e-bc14-7c74b6224034",
"db_country_code": "sample string 28",
"feelist_id": "cc06781d-b5e2-4559-b2a6-301826d7f594",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f5b58949-9115-4f98-99e0-f19ab84342e2",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "733cd725-1625-47ba-acc6-1366b3cd3d3b",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-18T00:37:23.2415227+00:00",
"db_currency_id": "0a26aff6-f45f-4ad8-babf-27f7ae0895a5",
"db_currency_code": "sample string 10"
},
"company_type_id": "6d0c56d2-4ca7-45b2-9117-cc795ec2a921",
"company_type_name": "sample string 32",
"company_type": {
"id": "bb4ee352-ee8d-44cc-8047-710503c191a0",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bee96c1e-cae4-4ab3-87bb-cbc3698a51e1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "36d24f77-ebbf-4228-8b3d-385f4b37111a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0bb6aae4-3fc0-47e5-bd99-50c580cb9370",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "55472b2f-13ed-4218-bb71-d07e391cf6fb",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d215ba32-35a6-40a1-904d-ec45578c19cc",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-18T00:37:23.2415227+00:00"
},
"company_sector_id": "28c1eaec-0e84-4c2d-a8a6-7b856f08a215",
"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": "9dfb431e-500d-428f-b0d7-34c418a29823",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "a2fff989-c668-4d5c-92e8-d164aaafc242",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "4d36fd2f-c158-4f02-8bd9-a5b363e8f5f6",
"account_manager_user_code": "sample string 56",
"company_status_id": "d3651e28-5fec-41a9-aef6-3a64ac1b0485",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-18T00:37:23.2415227+00:00",
"id2": 60
},
"db_language_id": "4c381d59-3ba6-4949-abda-f6bde5989a87",
"db_language_code": "sample string 7",
"db_title_id": "7b543848-cf81-44c7-94fd-bdfba093ef17",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-18T00:37:23.2415227+00:00",
"create_date": "2026-09-18T00:37:23.2415227+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-09-18T00:37:23.2415227+00:00"
}