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": "cd20fdd9-57ae-4dda-8c14-f0bb9b00e27a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "dae9d4bd-0c09-4741-b5db-968e36b95467",
"company_code": "sample string 5",
"company": {
"id": "5dbcf54f-9179-479c-b69b-fedc1fc80302",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-01-15T12:52:57.8711725+00:00",
"sales_territory_id": "58831638-8a2d-43c9-afcb-2d71e4dab1b6",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "b1a5bd44-879c-4a9e-b201-079dbfc2d525",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "073f5b8f-26e8-49db-8421-844a760ae804",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7316739f-81cd-4619-9b88-2238429de634",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "20837e7d-eb3b-4966-8a8f-4e1468b26b05",
"db_currency_id": "bf199b24-86b9-42e1-bd54-731ad5dce2dd",
"db_language_id": "5a7db536-75d8-4898-9be4-c3c8188c667e",
"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-15T12:52:57.8711725+00:00"
},
"modified_dateutc": "2026-01-15T12:52:57.8711725+00:00"
},
"marketing_segment_id": "8f701520-3c91-4e36-9fec-e66aeaab40d6",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a93288f8-fdf6-4d87-bab8-580c52e84b40",
"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": "8303b3ba-b570-4f33-a148-796c5ca6a6c2",
"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": "c1f358f1-db37-48c2-be5f-8d0645376bfd",
"db_country_code": "sample string 28",
"feelist_id": "aa19a084-4f91-4e90-9ad2-183d71a91824",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "c6830a7b-085c-4c04-b9ea-b4c93c9df20e",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "fb54f454-ed81-4b23-bbf7-0c73a6b9398c",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-01-15T12:52:57.8711725+00:00",
"db_currency_id": "c7e8c7fb-2eb9-4940-8107-8b22c70f26a8",
"db_currency_code": "sample string 10"
},
"company_type_id": "00d91b91-3f23-4c72-a739-794e80be1cc7",
"company_type_name": "sample string 32",
"company_type": {
"id": "f13eb762-19d9-4a1f-bc83-f05e9b9ff329",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "ac354d66-24a3-4d0d-84f4-17b3bcdd5dac",
"sales_organization_code": "sample string 5"
},
"db_language_id": "aefd13c0-839a-46b9-81ff-1d83388724ab",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "f854cb65-35d0-4563-a438-5aa941cc0552",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "1cd14eb7-1054-4ab4-a34b-7fbd719d0897",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "9af4fb03-e8b2-4549-897f-22cc4c5ccd38",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-01-15T12:52:57.8711725+00:00"
},
"company_sector_id": "953ed564-0983-4158-9945-f54a5f2dc2aa",
"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": "f37e0145-9bea-4e0d-aba4-bbc93f0ce190",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "e52f3ccf-05d5-44e7-a501-986c04e081a3",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "63daa4bd-b1e1-4fdd-9b3d-1c8c9eefc13b",
"account_manager_user_code": "sample string 56",
"company_status_id": "3cb57e6e-915e-4c76-9ab6-799fbc353a91",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-01-15T12:52:57.8711725+00:00",
"id2": 60
},
"db_language_id": "9651e412-48d5-403b-902e-91a993be8292",
"db_language_code": "sample string 7",
"db_title_id": "81a7372c-6683-4264-acc8-5a16b7c07077",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-01-15T12:52:57.8867915+00:00",
"create_date": "2026-01-15T12:52:57.8867915+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-15T12:52:57.8867915+00:00"
}