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": "31723473-a29e-4b0c-b883-63b05e3dcf25",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "aa0d32f7-eda8-4600-ae71-577455ee7911",
"company_code": "sample string 5",
"company": {
"id": "4accef42-cf1a-4531-a704-e86a46a2fc4d",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-06-25T17:09:48.2786524+00:00",
"sales_territory_id": "1a3616a6-2392-412c-8dcb-1d641634f5c6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "ca7ea459-edde-48a4-bc9a-5143ad694617",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "8cf4837d-944c-4c73-a79d-8a1001204ca4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "82259c5a-b521-490d-9e76-26130795f732",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2ce5c8-c1fd-4e01-bb0f-14f191424a1c",
"db_currency_id": "91a120b5-cff2-4dfd-8ffa-b9c92ab7f30e",
"db_language_id": "68c909bf-4ee1-4f5a-97af-71abab29a7e9",
"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-06-25T17:09:48.2786524+00:00"
},
"modified_dateutc": "2025-06-25T17:09:48.2786524+00:00"
},
"marketing_segment_id": "95086000-fe5b-4e9a-be84-6bed586ea249",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "09ee3151-8a29-4ffd-aee8-3187a3df7852",
"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": "4bbe6ece-7e81-499a-a445-f30b5bc3070d",
"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": "5aa07860-1e14-44ef-87fd-53f94ae43c6e",
"db_country_code": "sample string 28",
"feelist_id": "c1a68080-36c7-4594-b79d-0a2968e4ccd0",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "7de529be-7f8e-40db-9bdd-e9b402103447",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "d138b69a-ec24-439c-a118-b1bac265b349",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-06-25T17:09:48.2786524+00:00",
"db_currency_id": "ff9e1b93-67b8-49e4-ab73-c3a6fd4a3daf",
"db_currency_code": "sample string 10"
},
"company_type_id": "104c0d1e-0e76-4356-9d05-068615246d2d",
"company_type_name": "sample string 32",
"company_type": {
"id": "a7334d44-347d-4f12-bf01-5892501392ee",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "93e22efa-8887-44c8-9f5b-09f72a42496c",
"sales_organization_code": "sample string 5"
},
"db_language_id": "f1654efb-6eb2-4fe1-b96f-faab59b58faa",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "0da6c445-b7f8-4955-9e14-59717e11ad81",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "4016e11d-8065-4c61-b943-86f85f8a1e71",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6783a79e-72b2-4dc2-8a30-89c51861745d",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-06-25T17:09:48.2786524+00:00"
},
"company_sector_id": "ab4dacef-afb0-4a47-bf14-c7d997a7cbf3",
"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": "a97129e5-fcea-49fb-a420-d9c9081089af",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "7dd30b8a-7ea7-4d79-a51e-df3327b31137",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "ff892c7e-5b37-40f6-9035-157e08722def",
"account_manager_user_code": "sample string 56",
"company_status_id": "04faed08-3703-4b58-b0b6-471483c64c6c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-06-25T17:09:48.2786524+00:00",
"id2": 60
},
"db_language_id": "d3cadaa5-44df-4a1f-a1d1-c41129ed6e03",
"db_language_code": "sample string 7",
"db_title_id": "d8cf330c-3920-4965-a6b3-6dcac24b11bd",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-06-25T17:09:48.2786524+00:00",
"create_date": "2025-06-25T17:09:48.2786524+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-06-25T17:09:48.2786524+00:00"
}