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": "9df8f1af-fb84-4f9d-bcfc-4000781fe635",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f4469b08-ac54-4274-8f0c-1052015b0627",
"company_code": "sample string 5",
"company": {
"id": "91c114ae-b048-454a-bd46-0486d96a50d2",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-05-23T09:58:39.767894+00:00",
"sales_territory_id": "12410cc3-c34f-4746-b2be-1903bcff7759",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "3961dcbf-d2ce-4fb4-9b00-8721b68ea544",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "373fa986-3b0a-46e2-9f1c-5a92c59060dd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4c0a8e78-ecbd-4c60-86af-8c43ef1b6b70",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "30fbfe23-fbf8-4903-8a0e-f85751b73ba3",
"db_currency_id": "98b1c28d-171b-49d7-a62e-34efabfc2bd0",
"db_language_id": "35492ece-7aeb-416a-9742-91bf76bb0d99",
"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-23T09:58:39.767894+00:00"
},
"modified_dateutc": "2026-05-23T09:58:39.767894+00:00"
},
"marketing_segment_id": "e9631350-31c7-45d7-ab76-4fe07531ed39",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "5c74d920-0ca0-480d-a17c-d4c32c15d8a5",
"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": "4d85a20f-7e16-4f3f-bba0-0684c5d1d961",
"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": "c5f63943-029f-4504-83fb-0dfe96fbffd2",
"db_country_code": "sample string 28",
"feelist_id": "9bd5ed78-637b-493b-8dfd-819c94bfc2b4",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "775251b3-de1b-4a5b-937c-ed2027232794",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "c8f7eca3-e9fa-4441-9e93-f1e570aff8e1",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-05-23T09:58:39.767894+00:00",
"db_currency_id": "2799f658-6fd1-4b49-a702-35506b308165",
"db_currency_code": "sample string 10"
},
"company_type_id": "8c2ba5a8-76d3-4e5e-91a5-e5d99c18c72a",
"company_type_name": "sample string 32",
"company_type": {
"id": "f8d6c5d5-9eb8-4bb8-805f-5b5def6ef242",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "59c53da4-c87b-40d4-b8ae-90d924b8eb61",
"sales_organization_code": "sample string 5"
},
"db_language_id": "55a772d8-8c3c-42c6-8986-ff8722b0324f",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "e0e0d941-0717-4bc3-a0f9-7c021f92e2e1",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "b9aa2372-ae3f-4240-b3bd-d8a54c914233",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "fb66e1d3-8ea3-4337-a897-ca072d1650e6",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-05-23T09:58:39.767894+00:00"
},
"company_sector_id": "1642edbc-15de-4475-b1fd-71e1ed0d23bd",
"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": "1bcb8efd-9c39-46ce-af52-41df448aba1a",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "3666beb7-340e-42dd-89bd-4675d0fc746c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "dfa41695-a255-401a-8295-83d089bf8518",
"account_manager_user_code": "sample string 56",
"company_status_id": "e23ff7c0-1834-4fd5-83c7-c2258aa855d5",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-05-23T09:58:39.767894+00:00",
"id2": 60
},
"db_language_id": "89f287ba-47f9-4e93-9a38-3b67f644c578",
"db_language_code": "sample string 7",
"db_title_id": "283e42a8-9bc4-44ac-9087-565ed779ba52",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-05-23T09:58:39.767894+00:00",
"create_date": "2026-05-23T09:58:39.767894+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-23T09:58:39.767894+00:00"
}