Retrieves all the company contact
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": "b4de67d9-7320-40bc-9912-3d9ed90971a5",
"firstname": "sample string 2",
"lastname": "sample string 3",
"company_id": "e573714e-82b6-4087-b307-71b7c8b3e793",
"company_code": "sample string 5",
"company": {
"id": "53677800-3c31-4f0f-877e-9c131ff4dbb4",
"is_client": true,
"is_supplier": true,
"archived": true,
"name": "sample string 5",
"notes": "sample string 6",
"create_date": "2026-11-10T17:02:54.1509033+00:00",
"sales_territory_id": "1c99046b-fffb-4f2a-bbb7-323d927dbc8a",
"sales_territory_code": "sample string 9",
"sales_territory": {
"id": "8afdcef6-b958-4ce4-acc5-996641b9a793",
"code": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "353bff99-1506-4d0c-bb75-d31cb79d7941",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8decddb5-4d19-4a91-80a9-802f6afa3418",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "28278bdc-7689-4b44-ad6f-c00af060ffe6",
"db_currency_id": "f9e6c40a-835f-42f9-8d8d-6bc303636b23",
"db_language_id": "99a4594f-3170-41ef-93bc-93ca4ed961ae",
"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-11-10T17:02:54.1509033+00:00"
},
"modified_dateutc": "2026-11-10T17:02:54.1509033+00:00"
},
"marketing_segment_id": "faf8a5ae-1395-4775-8fce-744674838506",
"marketing_segment_code": "sample string 11",
"sales_organization_id": "e7118e6a-8cf2-4a71-8165-d70edc275f2c",
"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": "89bc27a4-b35e-42a0-bc61-23f006ee6aad",
"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": "7bf5485e-9d4a-449e-a4e8-95abdefd5cac",
"db_country_code": "sample string 28",
"feelist_id": "d4b34407-9732-4e3c-90db-0b9ccf6673d2",
"feelist_reference_back_office": "sample string 30",
"feelist": {
"id": "78369108-cddd-4aae-92ee-1a0cd237b898",
"name": "sample string 2",
"description": "sample string 3",
"is_default": true,
"default_price": 1.0,
"sales_organization_id": "82add527-6e1d-48a8-bcd2-2393f1581526",
"sales_organization_code": "sample string 6",
"reference_back_office": "sample string 7",
"modified_dateutc": "2026-11-10T17:02:54.1509033+00:00",
"db_currency_id": "54b4cf7b-d1e4-4245-b9e5-bb0669fd3771",
"db_currency_code": "sample string 10"
},
"company_type_id": "d94d3dda-0994-4f9c-bc9a-f065856d0363",
"company_type_name": "sample string 32",
"company_type": {
"id": "29c2d0bf-9cdb-4317-9ea5-47a36fd561e3",
"name": "sample string 2",
"description": "sample string 3",
"sales_organization_id": "f4924431-7fca-461b-90a6-021aa584786d",
"sales_organization_code": "sample string 5"
},
"db_language_id": "1e3bb8dd-5e8e-449d-82a3-783fe84624e6",
"db_language_code": "sample string 34",
"code": "sample string 35",
"article_price_label_id": "5bb82910-ddb7-4c40-9773-9d1ec4f4aac3",
"article_price_label_code": "sample string 37",
"db_payment_method_id": "697496aa-fe1b-4366-9cf1-c0af63a61e24",
"db_payment_method_reference_back_office": "sample string 39",
"db_payment_methods": {
"id": "6e51ddfc-af2a-420d-afd0-8c7e469d7fad",
"name": "sample string 2",
"description": "sample string 3",
"reference_back_office": "sample string 4",
"activated": true,
"modified_dateutc": "2026-11-10T17:02:54.1509033+00:00"
},
"company_sector_id": "12c9a63f-75f4-4393-a67b-592d8183f7bb",
"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": "6fc6e2b8-c1ce-4d1f-9340-144678d3c363",
"service_manager_user_code": "sample string 52",
"finance_manager_user_id": "8bb031d1-f0a0-4edd-8a27-28c812582587",
"finance_manager_user_code": "sample string 54",
"account_manager_user_id": "23a74210-f2c6-457d-839b-4130e6c90b8a",
"account_manager_user_code": "sample string 56",
"company_status_id": "fede018f-14a6-45d6-a8d1-a32b80a75dff",
"invoice_email_to": "sample string 58",
"modified_dateutc": "2026-11-10T17:02:54.1509033+00:00",
"id2": 60
},
"db_language_id": "fd29d176-b529-48d4-a67f-ab0d60f8dcf7",
"db_language_code": "sample string 7",
"db_title_id": "b566d7d1-9efb-41ac-a196-c9c00fa0309f",
"archived": true,
"functions": "sample string 10",
"e_login": "sample string 11",
"e_password": "sample string 12",
"notes": "sample string 13",
"birthdate": "2026-11-10T17:02:54.1509033+00:00",
"create_date": "2026-11-10T17:02:54.1509033+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-11-10T17:02:54.1509033+00:00"
}