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": "828e3946-f392-4047-a6a7-74b7fb7bd59a",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "ec7a0bb2-3c6a-438b-80c2-8e724a6f5cea",
"company_code": "sample string 5",
"company": {
"id": "953d2b21-aa23-4dd9-a1c7-97e7143d0aa8",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-02-21T03:26:22.9207467+00:00",
"sales_territory_id": "f3cbc7e7-b6a1-4543-a21d-37b2a41d2a51",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e60ccd69-de29-4da7-920d-e7431266506c",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "045b0710-9ffc-4a1a-95dd-8f7c64b6582c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "673571f9-2815-4cd5-9496-fbcd8925cc80",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8fdb9a48-fa54-4cad-9861-478415e478c9",
"db_currency_id": "1dccf7d6-d0e8-4eba-bc79-105526f83a1f",
"db_language_id": "8d444e5e-54e9-44d6-a3aa-f83574822d2f",
"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-02-21T03:26:22.9207467+00:00"
},
"modified_dateutc": "2026-02-21T03:26:22.9207467+00:00"
},
"marketing_segment_id": "8531b172-c656-4c62-b90f-161b229dd762",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "c0ba1057-f37b-4186-af98-542b3a35f17a",
"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": "157d3b3d-15dd-457b-8345-5a354d100c15",
"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": "ce93181a-a6ac-4323-ad8e-f39e81465baf",
"db_country_code": "sample string 28",
"feelist_id": "793cbe5c-09a7-43d1-9e70-0d305b221af1",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5e0407cd-ff6f-4c94-bedf-6416428aeed9",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "9e5f1f1b-f3ea-4904-9831-e164acd76d74",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-02-21T03:26:22.9207467+00:00",
"db_currency_id": "c1d412d6-715a-4d4f-94d7-f17d6e607ffa",
"db_currency_code": "sample string 10"
},
"company_type_id": "835f9de5-b8c6-4d12-9680-7cbfc0e01b28",
"company_type_name": "sample string 32",
"company_type": {
"id": "8888315f-e303-4351-88bd-63c9d780f8b4",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "88a1d06b-81a1-45b9-9e47-abb48cfec2fd",
"sales_organization_code": "sample string 5"
},
"db_language_id": "5c7e4fef-a0a6-434a-aeaa-4b9550454210",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "1a91eed2-d1b6-4789-b69d-3312e0feee6c",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "078eb5ac-4d98-4a92-af67-0dc765a447b9",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "d0a38325-af8e-4e2d-99ab-b20bbd2f7772",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-02-21T03:26:22.9207467+00:00"
},
"company_sector_id": "451fad24-9eb2-4a52-b1bb-06e0c5349154",
"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": "06a3b7eb-686a-45be-8b16-b99190e26c36",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "835666ce-835d-4c73-8c4a-cad0d475d213",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "9460c355-7ec9-4a58-b079-ff2627bfce9a",
"account_manager_user_code": "sample string 56",
"company_status_id": "50d3d6fc-918e-4b0e-b888-dc30a32d2f07",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-02-21T03:26:22.9207467+00:00",
"id2": 60
},
"db_language_id": "98ce0638-9657-4e13-a7d4-70bfc37f3378",
"db_language_code": "sample string 7",
"db_title_id": "789647b6-e8f0-4672-b098-7a93efeb5fda",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-02-21T03:26:22.9207467+00:00",
"create_date": "2026-02-21T03:26:22.9207467+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-02-21T03:26:22.9207467+00:00"
}