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": "b7d61ede-bda3-4173-801c-f3cc141e4092",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "de5a4ccd-b95f-4ec1-9533-3718b09b45cd",
"company_code": "sample string 5",
"company": {
"id": "62578aa6-6d33-4d81-a308-1e81a28b1ab7",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-11T06:50:06.5188708+00:00",
"sales_territory_id": "a6518c3b-7c87-45a6-884b-a834f0b72f1e",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "c488fc4c-e6fd-4148-b3b9-d98c236f4db6",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "c0512088-06b9-4840-868f-7b925784289a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5c07035a-9374-47e6-bf3b-7806455f1cfc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "22c2cb0f-0807-4ccf-a857-600fcf20e3b0",
"db_currency_id": "071f4f71-c2ba-445f-ab39-e8877e36583a",
"db_language_id": "525ab7c2-7e8d-4d81-84ed-75a85efd8b45",
"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-01-11T06:50:06.5188708+00:00"
},
"modified_dateutc": "2026-01-11T06:50:06.5188708+00:00"
},
"marketing_segment_id": "5ac30d44-58db-4195-8a2f-1a093d0149d0",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "88969a83-0f8b-4397-8bd3-0904d31b851a",
"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": "9d822cb4-8a3c-4881-bcfa-3a062c184387",
"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": "119c9eff-44b6-4fda-9bf3-1639aba5014b",
"db_country_code": "sample string 28",
"feelist_id": "4800e1e9-aec1-401f-95f2-d4feed04ce3a",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "beb255f5-2405-42a6-b2be-ebed694ea3e0",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "afd0f345-ba93-4c79-89ff-d2a510707b93",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-11T06:50:06.5188708+00:00",
"db_currency_id": "2eca7058-15c5-4a49-bde9-b6c430f3f9e2",
"db_currency_code": "sample string 10"
},
"company_type_id": "d1ea2176-b62a-48f3-a97b-7d6946e6d026",
"company_type_name": "sample string 32",
"company_type": {
"id": "b1b8b489-6892-4796-996a-dcd8a64c190f",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dac99fd3-a79a-42c0-a5bf-a150b317950e",
"sales_organization_code": "sample string 5"
},
"db_language_id": "3df6fc62-29ff-4ebf-a8bb-d8c1bf997c59",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "c579a743-d481-45e4-aeee-73645efdb189",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1382bb36-b0a4-4e55-a309-c3a1afde9cd0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "96102f64-6bf5-4c8c-a5c0-aaf1f109fcbf",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-11T06:50:06.5188708+00:00"
},
"company_sector_id": "6f48f286-7491-4d67-9538-7efa330b1119",
"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": "4fbff753-2e7b-4360-931c-9b2fe72b5ac0",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "0ab1cc80-32eb-4b88-bbb3-8194d91591a1",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "fead1189-a9b5-4c49-b5cf-9d067a119754",
"account_manager_user_code": "sample string 56",
"company_status_id": "8af920ab-3d72-4812-8d2d-39d49a9071a3",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-11T06:50:06.5188708+00:00",
"id2": 60
},
"db_language_id": "3321ad48-7831-44f5-99aa-61c837d901db",
"db_language_code": "sample string 7",
"db_title_id": "da581a7e-61ef-44b0-89d8-d5c9c09deec5",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-11T06:50:06.5188708+00:00",
"create_date": "2026-01-11T06:50:06.5188708+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-01-11T06:50:06.5188708+00:00"
}