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": "4ff37ddc-1153-4a2e-a0a5-fe5c68781ed9",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "05243765-1ef3-4bcc-b45f-bef4d0e849d8",
"company_code": "sample string 5",
"company": {
"id": "5969831b-d0ae-4d07-9e1e-70ad473227a6",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-12-18T12:14:21.8433052+00:00",
"sales_territory_id": "0d412547-8409-423e-958c-8443a5372d78",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "613b33b4-824a-488f-b4b5-f61b39feaae4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4f93202c-f598-4e4e-9158-f68cd04dbccf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf5a6218-12b1-45b1-81b9-d53566612dbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "277f8982-3216-4a5a-b8e9-de2d01b652ba",
"db_currency_id": "a31d2ad5-758c-4547-b9c3-b1b7a17cebc2",
"db_language_id": "3e8aec5d-edef-4d85-92f0-0e6c84793b72",
"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": "2025-12-18T12:14:21.8589216+00:00"
},
"modified_dateutc": "2025-12-18T12:14:21.8589216+00:00"
},
"marketing_segment_id": "6d3b6a8d-2245-4bcc-a0da-6c5e15c5fa7f",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "d9c77e25-543e-4fa8-a091-d4a715ff34e4",
"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": "5eddbee3-7a2a-4dd5-aa33-0133d28d00d9",
"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": "aee08c0c-e4a3-4ea5-8ba2-09d04ab22664",
"db_country_code": "sample string 28",
"feelist_id": "d96646c2-1fec-41e3-91c5-8642264b4040",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "f9136a73-3f5d-46b5-b68d-34173bda1d9f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a1a0422e-f9ed-44f5-9919-3335d9cf24ea",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-12-18T12:14:21.8589216+00:00",
"db_currency_id": "b57650ee-3053-46a9-8b14-24102a829450",
"db_currency_code": "sample string 10"
},
"company_type_id": "7c1ec9d8-e9ba-4a6e-8ef7-c7f399f06a1c",
"company_type_name": "sample string 32",
"company_type": {
"id": "298763f0-531d-4dab-8942-2b76703ae7c8",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "582f7f34-043d-4db4-b016-0b356aad305d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "fda7a29c-64c3-4bb7-9d89-7979eb746120",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "b82e6db8-7505-42b2-ad51-4deb513b3574",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "77419725-05f0-4692-97b3-cc04b2dfcc18",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "4fb92b6a-0e31-4931-a75b-899a5910e90a",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-12-18T12:14:21.8589216+00:00"
},
"company_sector_id": "2bb8d12c-0703-420d-b555-93f1aad85e9d",
"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": "b7e8f9c7-0a03-4e55-811a-6d996b4edc60",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "81eb58a6-5d59-49aa-9096-3ca974b20f62",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "d122733d-6dbe-4e95-9ced-00d7630cee01",
"account_manager_user_code": "sample string 56",
"company_status_id": "ba581e58-585c-434a-9954-7ad8477a100a",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-12-18T12:14:21.8589216+00:00",
"id2": 60
},
"db_language_id": "ad079b19-7b5a-4dc1-b975-a10a2305711c",
"db_language_code": "sample string 7",
"db_title_id": "43f5e90a-7760-4920-9085-2632d1e3c0dc",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-12-18T12:14:21.8589216+00:00",
"create_date": "2025-12-18T12:14:21.8589216+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": "2025-12-18T12:14:21.8589216+00:00"
}