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": "a0d8b1b1-97c3-4eb3-83f1-843f821dad8d",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ca63566f-d633-42ac-b3f8-589a0c34aab5",
"company_code": "sample string 5",
"company": {
"id": "73334f41-7ec9-449c-884b-560eaa866b57",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-04-16T20:53:27.3864589+00:00",
"sales_territory_id": "966250a4-8db3-4d92-a346-bc4c7ccd2e22",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "64bdeb13-2d53-49af-a8e1-09fe1c282ba4",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ae9b32bd-efad-4ca9-ba49-3d88bd4e2418",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20c0092b-619b-49cb-b55f-17d31d2e48cb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f870067b-42a2-4116-b58e-8d20f88e52ac",
"db_currency_id": "f5f715d6-04ff-4b25-a843-6512e8d20e17",
"db_language_id": "7287114f-fa0d-41a8-a55a-a701cb399558",
"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-04-16T20:53:27.3864589+00:00"
},
"modified_dateutc": "2026-04-16T20:53:27.3864589+00:00"
},
"marketing_segment_id": "fdc55b5b-963d-4509-ada9-f0cd4ad5fe00",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "48b7e5cd-84a0-47d8-91f9-b1e363a6a6d1",
"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": "b1a372ee-f16f-4175-a48c-cad56d8de3bd",
"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": "2a928bfd-4737-4b01-8f26-ef90e31e7269",
"db_country_code": "sample string 28",
"feelist_id": "fc193c7a-3d57-40ba-9705-7881f65af2c2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "91df4240-5757-4c3c-9e16-4f7ae5b323db",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "31aa415e-86fa-4895-8616-e6b674ff4832",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-04-16T20:53:27.3864589+00:00",
"db_currency_id": "ae8a7a40-0264-4ec9-9256-59989abb1078",
"db_currency_code": "sample string 10"
},
"company_type_id": "421b5e5a-6197-4dae-b074-f2d4a48917e6",
"company_type_name": "sample string 32",
"company_type": {
"id": "641d4c76-ad7c-437f-aedc-9ec923edda72",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "40308966-447f-4317-8bc8-3f37c5152fda",
"sales_organization_code": "sample string 5"
},
"db_language_id": "b08bd76f-394a-407d-a1ec-be60883ab981",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9c2b0aa3-1527-4648-b827-f63438d904f4",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "31ee55ed-9fe0-4f24-8fe0-df666b810dc9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "3e86287e-c4b4-4e6c-ba67-14ff867b0b11",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-04-16T20:53:27.3864589+00:00"
},
"company_sector_id": "47f6064f-40b1-4a3e-819b-b54ba0478236",
"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": "4b13742f-c712-45a3-a1c0-2b977e0cdc5b",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "1d807f87-372f-418c-934e-7fb21b1ff70c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "249fb2ff-2717-46df-be09-3f2582f5191f",
"account_manager_user_code": "sample string 56",
"company_status_id": "2ec10ce2-30fd-438a-afad-301420526c9c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-04-16T20:53:27.3864589+00:00",
"id2": 60
},
"db_language_id": "879a208e-e38d-4494-9af4-7430a2c3db04",
"db_language_code": "sample string 7",
"db_title_id": "6a32029c-154d-43a5-8df9-854ab6aca780",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-04-16T20:53:27.3864589+00:00",
"create_date": "2026-04-16T20:53:27.3864589+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-04-16T20:53:27.3864589+00:00"
}