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": "ea9260e1-733f-4b5c-922c-981dbdb076ce",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c0cffced-42e5-47ac-b40d-419864811187",
"company_code": "sample string 5",
"company": {
"id": "62e5e90e-b4a5-41ac-8d04-42e862f7b7ee",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-09-21T02:24:25.329644+00:00",
"sales_territory_id": "fabacdd9-9886-4f7b-b5f8-078a66cd3e75",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "2b033a3e-2546-4fe7-940e-44c2d4992b91",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "3515f953-7e0f-4f6d-b8fb-bbede29a8df9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "187018e8-171f-4d69-bbc0-f4b3ed4b9f3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "955ab90b-b030-4378-8363-9a3627b1af72",
"db_currency_id": "613d0154-5e65-4aec-9ce6-07b0daafe098",
"db_language_id": "5c668abb-10a7-44b6-9c58-d66818b76b46",
"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-09-21T02:24:25.329644+00:00"
},
"modified_dateutc": "2026-09-21T02:24:25.329644+00:00"
},
"marketing_segment_id": "7599b449-e20c-4432-af93-d8ae5a53cd6b",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "b2eed3c3-6317-4229-91c9-afeb1242a73b",
"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": "1177a33a-3728-4d42-a718-5da1cbc18828",
"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": "a6a50dd9-0d5f-45de-9302-4cccd432b576",
"db_country_code": "sample string 28",
"feelist_id": "2fc2810b-a906-49e0-82f4-4d3a07738382",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "a52534a0-c7c6-46d4-ab10-6c3c1cf5613f",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "397a2c64-0f7f-4c48-a050-5608d112a74e",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-09-21T02:24:25.329644+00:00",
"db_currency_id": "d18a16b0-579f-4e54-9b4c-05b3702a4fdd",
"db_currency_code": "sample string 10"
},
"company_type_id": "99c7adb4-bd6c-4390-b125-01fefddefbe6",
"company_type_name": "sample string 32",
"company_type": {
"id": "da15e300-d358-4f24-9c28-41cf822a2464",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4545095a-a48b-4709-86a7-d50a3e10eb2d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "e673dae4-2ef4-4568-b2c1-e21df41694a1",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "9e5f1556-b16e-4c92-819a-19714a78811f",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "327137f3-2411-4f19-8a65-40bb3f5ab6d0",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "8f265bbd-dfaa-4db4-a6ec-46934cdf7792",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-09-21T02:24:25.329644+00:00"
},
"company_sector_id": "2b4d0ce5-22fe-49d4-a2d5-3416f7c82192",
"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": "88a1b84b-5408-4151-b9cd-dfccf12fda8f",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f37a514d-bdc3-422a-b6ce-ed8e4ddc5082",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "aaca3d55-d043-45ab-8079-93a7e11b5a9d",
"account_manager_user_code": "sample string 56",
"company_status_id": "4f5a2f08-5428-42fc-ae06-fa5050f1108c",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-09-21T02:24:25.329644+00:00",
"id2": 60
},
"db_language_id": "e7842116-78e6-44c1-9462-f33d824c900b",
"db_language_code": "sample string 7",
"db_title_id": "18101fed-ccc4-40bb-bb38-92cf3c24e8fb",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-09-21T02:24:25.329644+00:00",
"create_date": "2026-09-21T02:24:25.329644+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-09-21T02:24:25.329644+00:00"
}