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": "58705c4d-201e-4654-9096-37c526fa0b1b",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "c784ba03-612e-4996-8a8b-6620e424e0fa",
"company_code": "sample string 5",
"company": {
"id": "f7950e96-cb22-4957-94cd-3c5789700720",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-04T02:31:33.2242558+00:00",
"sales_territory_id": "8ae31fac-e953-4b47-8b1a-3c83843026ba",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "599b7be9-ae39-46bb-8d36-bdae855af186",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "dc7262f9-5f6d-4765-8ec3-0fcd1423a573",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6edc8dd0-e87f-427a-bdf7-45c0de923147",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e461c75d-3a83-477b-a648-b005d2061653",
"db_currency_id": "cdbcd50f-1f08-48d2-a350-f41ed42f3034",
"db_language_id": "f26763bf-3fb0-45cc-88dc-09d4175f6ae6",
"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": "2025-04-04T02:31:33.2242558+00:00"
},
"modified_dateutc": "2025-04-04T02:31:33.2242558+00:00"
},
"marketing_segment_id": "ac5a176d-a424-4576-b7bc-6f717b9e7762",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "19c7cc7c-2805-44b8-a1d8-c3998ef910ac",
"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": "b6ab380d-5650-4659-bb20-594a017ddf23",
"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": "0c1bb858-8c31-42bf-b68d-85841c93dd40",
"db_country_code": "sample string 28",
"feelist_id": "751559fc-44cc-4576-9700-9c8ed2987a6c",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "539f3657-bd3b-4f22-bac8-64d7251b901a",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "a2a277ee-11fd-4407-a9fe-789ac64edc6a",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-04T02:31:33.2242558+00:00",
"db_currency_id": "14e6c075-9add-4000-845b-89a5af8b02e4",
"db_currency_code": "sample string 10"
},
"company_type_id": "85b28408-5ec7-4f72-a278-e630f3ee995e",
"company_type_name": "sample string 32",
"company_type": {
"id": "2bd5a198-088a-4e70-99c1-84136882e530",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "bbd43c27-dba6-4501-a3e2-5c94ee137099",
"sales_organization_code": "sample string 5"
},
"db_language_id": "55c965e4-822d-45ae-aab6-9e22fe467a6a",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "ac013329-30c4-44f5-b6ef-77007eeeb637",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "e8b231d8-4275-42da-bec1-decf90b76bbe",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "22f60ede-3333-40b0-964b-fd39363e4afe",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-04T02:31:33.2242558+00:00"
},
"company_sector_id": "2ae13b36-8db7-4923-ae64-ca28afa1df8f",
"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": "f8c8b143-19f3-4bf3-aacf-68ca15f52db9",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "f0df49e9-8e9c-42a2-91cb-a4a0fbc50a2c",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "bde01515-3db0-474f-b815-d1c52c02343b",
"account_manager_user_code": "sample string 56",
"company_status_id": "acaca83f-70e9-46e0-a335-29dfb99e6161",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-04T02:31:33.2242558+00:00",
"id2": 60
},
"db_language_id": "35fbf7e1-1f4b-4167-9a4a-a19dcc824278",
"db_language_code": "sample string 7",
"db_title_id": "4d423c60-9d6c-4852-9d61-7fc7a2cfc1e0",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-04T02:31:33.2242558+00:00",
"create_date": "2025-04-04T02:31:33.2242558+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": "2025-04-04T02:31:33.2242558+00:00"
}