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": "abf8c2db-4e0f-4994-8aea-cd5b10b138ba",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "acf016a6-a88b-48c3-972f-4ef2d5f8ea9c",
"company_code": "sample string 5",
"company": {
"id": "2d255477-6d52-4d11-b05d-82bc0a88ab10",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2025-04-23T21:42:29.3511294+00:00",
"sales_territory_id": "3c39561c-ac7d-44f3-bdcc-37ea28d23be5",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "e0739b8d-b70e-4183-9acc-8a1c7b527283",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "4a45f41d-0bc5-45da-a46d-eaf5cecfdc36",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b32311d6-c3f1-4032-a87f-80d56e519986",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c0810cbf-83e7-406a-b7f1-c2bafa7be092",
"db_currency_id": "4c6bc2c6-f670-4d02-aa95-9e5b848a8565",
"db_language_id": "d3bb5590-d2f2-48c8-9325-b32e720602e0",
"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-23T21:42:29.3511294+00:00"
},
"modified_dateutc": "2025-04-23T21:42:29.3511294+00:00"
},
"marketing_segment_id": "0cefa077-d381-4c09-a07d-9f5ced697c55",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "a5382822-1bc3-46e1-aace-cd6bdb6d9ad4",
"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": "2aabff58-0278-4d9a-a004-af283fe7278b",
"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": "b707fa33-3b94-4b87-a1c2-edd2deed39da",
"db_country_code": "sample string 28",
"feelist_id": "d338272e-0a8d-4f4d-a4a1-0587f5c6449b",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "5cd6e501-f2f5-4c6b-bab5-394b71b63061",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "4483b7f7-9239-4a7e-a0c9-dd4c40023db9",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2025-04-23T21:42:29.3511294+00:00",
"db_currency_id": "cc081d18-07f4-4795-969c-97a6b4c756ba",
"db_currency_code": "sample string 10"
},
"company_type_id": "4a088747-5c91-4944-8a3e-fd708ece24bd",
"company_type_name": "sample string 32",
"company_type": {
"id": "8e1990fc-0a75-4f59-b0a8-1bdf6514369a",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "168ee550-d8b2-4a7f-8870-01501f378ded",
"sales_organization_code": "sample string 5"
},
"db_language_id": "4bed757e-0fd2-4e7d-82ae-bc39508d1eec",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "61627af5-366e-49ec-ac51-97a1dec4ecf2",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "9a299f6c-2a34-44e0-887d-32f2d6c1d084",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "04a7f898-d507-4f74-8adf-c00943dbf6c5",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2025-04-23T21:42:29.3511294+00:00"
},
"company_sector_id": "82f20f61-161b-4715-afe3-f22ae6d56b02",
"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": "3d8c5584-86a6-4710-9347-6f32159034ec",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "fff81e0c-a187-4016-9221-34a3a0b311ed",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "10731c89-ce7b-4af1-99e6-ea1c145e7bd0",
"account_manager_user_code": "sample string 56",
"company_status_id": "4fef9b7d-6eb0-42a6-a01c-018b9130811e",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2025-04-23T21:42:29.3511294+00:00",
"id2": 60
},
"db_language_id": "6072672f-c195-4fae-8daf-caede1098371",
"db_language_code": "sample string 7",
"db_title_id": "ddc2da18-dd56-4d49-90bd-8e62b46e0695",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2025-04-23T21:42:29.3511294+00:00",
"create_date": "2025-04-23T21:42:29.3511294+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-23T21:42:29.3511294+00:00"
}