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": "4ffd77dc-5f1c-4c48-9898-6bbc5e812807",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "f61c0375-c495-444c-981a-eb46d7e16b30",
"company_code": "sample string 5",
"company": {
"id": "c514aaf6-1bc1-44e3-801e-44039499a592",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-31T14:58:08.6655588+00:00",
"sales_territory_id": "155c5562-5af2-4e5a-85cc-0d042a766eec",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "1dafa1e0-927a-445d-ab77-af0c4e86366c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "7be72d4a-a789-49f3-b741-c82124c492af",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "030ae8a4-f935-4dc8-a4df-b89b941f3f46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bf04eba6-f917-4d5a-b7d4-69a1dc996029",
"db_currency_id": "e78bf93d-93b6-40a2-b953-b54e47b108a9",
"db_language_id": "ffa62bd2-9d10-4767-9eab-843e7095f41e",
"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-31T14:58:08.6655588+00:00"
},
"modified_dateutc": "2026-01-31T14:58:08.6655588+00:00"
},
"marketing_segment_id": "07c46bbb-1369-4574-803b-6970a7ba1e70",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "25832f90-9a1f-413e-9b84-ffdaad86702e",
"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": "470943a5-a042-4ad8-8ad2-54182fe29eb6",
"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": "c153d80e-8d7d-4f67-8035-68c6c611e1dc",
"db_country_code": "sample string 28",
"feelist_id": "e6498eec-fff9-43f5-8728-90a836796c1f",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "e4ddd517-73e0-4e3b-8343-df4202009ec7",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "e21195d9-5688-4426-990f-4e3ee5224007",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-31T14:58:08.6655588+00:00",
"db_currency_id": "0dd179d4-e240-483e-8c3b-b763b67c6d91",
"db_currency_code": "sample string 10"
},
"company_type_id": "3b1139cd-65df-47ab-a1d3-f51bda7ed93e",
"company_type_name": "sample string 32",
"company_type": {
"id": "dcd9114a-88f4-435a-878e-534a0f2a9a0d",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "fafc2128-cca3-4592-98d7-784526da93e1",
"sales_organization_code": "sample string 5"
},
"db_language_id": "17ec80d9-020d-4968-8e52-04df4cdea32b",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "50126e3a-4e7f-49b2-b66f-7f77ec53a61a",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "7a249afe-4084-42f2-bc3b-407d0c29d043",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "b6b947cf-d141-4215-994c-2e5fcf298e3f",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-31T14:58:08.6655588+00:00"
},
"company_sector_id": "1cdcbb68-4004-4324-99e7-e64928cee572",
"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": "63139180-2685-41e8-a6aa-88612c5e0549",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "9424c52a-19e2-444b-806e-f832ef4b46fb",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "24b601b0-e642-4635-9827-b3e625fa2106",
"account_manager_user_code": "sample string 56",
"company_status_id": "5de97e97-58d5-4e23-acbb-533e4f50fd32",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-31T14:58:08.6655588+00:00",
"id2": 60
},
"db_language_id": "4e437cc6-5a66-4531-b51f-94c3e7cffd0a",
"db_language_code": "sample string 7",
"db_title_id": "17ae04fb-133b-4c77-b526-5b586b704912",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-31T14:58:08.6655588+00:00",
"create_date": "2026-01-31T14:58:08.6655588+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-31T14:58:08.6655588+00:00"
}