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": "b688bddf-0a81-47e8-9da3-e85abdf0f626",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "10ff837e-f5d4-47da-84a0-9749c0c13ace",
"company_code": "sample string 5",
"company": {
"id": "1704554f-0283-41f0-a8e5-6d479e200fcd",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-03-11T00:43:50.2085114+00:00",
"sales_territory_id": "9e3521f3-e7c2-41fe-a847-69349e910ef0",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "a726e77e-4af5-429e-8057-8c3d14a5093d",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "d1396e3c-baf5-479d-9242-391530d3e60a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b408e7c5-00c5-4621-b029-96f816ea0e65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "385fcb01-b9df-47c3-8c11-bc72df3dd9d6",
"db_currency_id": "d5dea1f0-b16c-4afc-b184-6f7d5fe91e29",
"db_language_id": "4a763d81-e9fc-44b7-92d4-029453d9ab08",
"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-03-11T00:43:50.2241318+00:00"
},
"modified_dateutc": "2026-03-11T00:43:50.2241318+00:00"
},
"marketing_segment_id": "16317cff-2dcb-4b71-b5f9-e02a69c77254",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b3fd496f-0a20-4201-890b-b9f746ebff71",
"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": "ee16a022-91ca-47ee-9272-459fcba0f858",
"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": "34fa216d-0023-42b1-b15c-8039ffc86784",
"db_country_code": "sample string 28",
"feelist_id": "bfbd1bd5-9148-4061-9aef-38f1c05c5d77",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "df217f07-8788-4523-b640-0aa318f7f37a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "86b03730-1a91-4d7a-a709-e83e05a5aa64",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-03-11T00:43:50.2241318+00:00",
"db_currency_id": "73d4d49d-7d9c-4fd0-8c16-84b1a21422eb",
"db_currency_code": "sample string 10"
},
"company_type_id": "7dd70b67-fc21-49ff-82bf-cdaa2d0398a5",
"company_type_name": "sample string 32",
"company_type": {
"id": "3892a79c-3288-46b7-9819-1160508a5502",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "689e30d6-da1e-4a75-8371-8bb7693ed48a",
"sales_organization_code": "sample string 5"
},
"db_language_id": "6657dbec-1c6c-45a9-8ee5-260cf94d57b3",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "bc54e015-3dc7-4596-b541-cb121433d50a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "056ceea7-4b97-40e5-996f-ed7d250887c1",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3369bdc9-f70b-4314-ae30-9f6ade1419fd",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-03-11T00:43:50.2241318+00:00"
},
"company_sector_id": "3003f718-7fe2-47a8-a724-f18c84fc1e1f",
"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": "45ea09bc-cba2-48a8-ab6d-7d01cc4e4ef2",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "64966280-5b45-450a-8244-27f6571497bf",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "94fc8079-3283-4a1a-b61a-d13b72a25a4b",
"account_manager_user_code": "sample string 56",
"company_status_id": "e89a0b12-7ba1-42db-91b9-f910fb2e6d84",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-03-11T00:43:50.2241318+00:00",
"id2": 60
},
"db_language_id": "b018e558-e467-4523-aad1-ef21cebea09e",
"db_language_code": "sample string 7",
"db_title_id": "9043e2ca-352d-47f2-8427-e2d3287e1ec4",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-03-11T00:43:50.2241318+00:00",
"create_date": "2026-03-11T00:43:50.2241318+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-03-11T00:43:50.2241318+00:00"
}